From 3e25a212b9f67c91f0df214c78847856a2d66e49 Mon Sep 17 00:00:00 2001
From: Mathieu Faverge <mathieu.faverge@inria.fr>
Date: Mon, 14 Dec 2020 14:00:25 +0100
Subject: [PATCH] Quick fix on file headers
---
cmake_modules/local_subs.py | 13 +++++++++++++
include/spm/const.h | 4 ++--
src/drivers/iohb.c | 7 +++++++
src/drivers/iohb.h | 7 +++++++
src/drivers/mmio.c | 15 ++++++++-------
src/drivers/mmio.h | 16 ++++++++--------
tests/spm_dist_genrhs_tests.c | 5 +++--
tests/spm_scatter_gather_tests.c | 4 ++--
wrappers/fortran90/examples/spm_driver.F90 | 2 +-
wrappers/fortran90/examples/spm_user.F90 | 2 +-
10 files changed, 52 insertions(+), 23 deletions(-)
diff --git a/cmake_modules/local_subs.py b/cmake_modules/local_subs.py
index 0ecd607b..a6e258d5 100644
--- a/cmake_modules/local_subs.py
+++ b/cmake_modules/local_subs.py
@@ -1,3 +1,16 @@
+"""
+ @file local_subs.py
+
+ Python SPM specific substitution rules for the Precision Generator script.
+
+ @copyright 2017-2020 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
+ Univ. Bordeaux. All rights reserved.
+
+ @version 1.0.0
+ @author Mathieu Faverge
+ @date 2020-07-16
+
+"""
subs = {
# ------------------------------------------------------------
# replacements applied to mixed precision files.
diff --git a/include/spm/const.h b/include/spm/const.h
index 3a915e76..3c5732ff 100644
--- a/include/spm/const.h
+++ b/include/spm/const.h
@@ -18,8 +18,8 @@
* @{
*
**/
-#ifndef _spm_api_h_
-#define _spm_api_h_
+#ifndef _spm_const_h_
+#define _spm_const_h_
#include "spm/config.h"
diff --git a/src/drivers/iohb.c b/src/drivers/iohb.c
index 7366c446..f249cb1e 100644
--- a/src/drivers/iohb.c
+++ b/src/drivers/iohb.c
@@ -1,3 +1,10 @@
+/**
+ *
+ * @file iohb.c
+ *
+ * Harwell-Boeing File I/O in C
+ *
+ **/
/*
Fri Aug 15 16:29:47 EDT 1997
diff --git a/src/drivers/iohb.h b/src/drivers/iohb.h
index c067fd30..15f60c50 100644
--- a/src/drivers/iohb.h
+++ b/src/drivers/iohb.h
@@ -1,3 +1,10 @@
+/**
+ *
+ * @file iohb.h
+ *
+ * Harwell-Boeing File I/O in C
+ *
+ **/
#ifndef _iohb_h_
#define _iohb_h_
diff --git a/src/drivers/mmio.c b/src/drivers/mmio.c
index a9257e69..5386cb37 100644
--- a/src/drivers/mmio.c
+++ b/src/drivers/mmio.c
@@ -1,10 +1,11 @@
-/*
-* Matrix Market I/O library for ANSI C
-*
-* See http://math.nist.gov/MatrixMarket for details.
-*
-*
-*/
+/**
+ *
+ * @file mmio.c
+ *
+ * Matrix Market I/O library for ANSI C
+ * See http://math.nist.gov/MatrixMarket for details.
+ *
+ **/
#include "common.h"
#include "spm_drivers.h"
#include "drivers/mmio.h"
diff --git a/src/drivers/mmio.h b/src/drivers/mmio.h
index ad586f50..eda8c45b 100644
--- a/src/drivers/mmio.h
+++ b/src/drivers/mmio.h
@@ -1,11 +1,11 @@
-/*
-* Matrix Market I/O library for ANSI C
-*
-* See http://math.nist.gov/MatrixMarket for details.
-*
-*
-*/
-
+/**
+ *
+ * @file mmio.h
+ *
+ * Matrix Market I/O library for ANSI C
+ * See http://math.nist.gov/MatrixMarket for details.
+ *
+ **/
#ifndef _mmio_h_
#define _mmio_h_
diff --git a/tests/spm_dist_genrhs_tests.c b/tests/spm_dist_genrhs_tests.c
index 27872e2c..0bd20678 100644
--- a/tests/spm_dist_genrhs_tests.c
+++ b/tests/spm_dist_genrhs_tests.c
@@ -1,8 +1,9 @@
/**
*
- * @file spm_dist_norm_tests.c
+ * @file spm_dist_genrhs_tests.c
*
- * Tests and validate the spm_genrhs routines in the case of random distributed vectors.
+ * Tests and validate the spm_genrhs routines in the case of random distributed
+ * vectors.
*
* @copyright 2015-2020 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
* Univ. Bordeaux. All rights reserved.
diff --git a/tests/spm_scatter_gather_tests.c b/tests/spm_scatter_gather_tests.c
index 3e2bcbb7..465caf2a 100644
--- a/tests/spm_scatter_gather_tests.c
+++ b/tests/spm_scatter_gather_tests.c
@@ -8,8 +8,8 @@
* Test and validate the spmConvert routine.
*
* @version 1.0.0
- * @author Tony Delarue
- * @date 2020-02-20
+ * @author Tony Delarue
+ * @date 2020-02-20
*
**/
#include <stdint.h>
diff --git a/wrappers/fortran90/examples/spm_driver.F90 b/wrappers/fortran90/examples/spm_driver.F90
index fba2a146..e2f036c2 100644
--- a/wrappers/fortran90/examples/spm_driver.F90
+++ b/wrappers/fortran90/examples/spm_driver.F90
@@ -1,5 +1,5 @@
!
-! @file spm_driver.f90
+! @file spm_driver.F90
!
! Fortran 90 example using a matrix read with the spm driver.
!
diff --git a/wrappers/fortran90/examples/spm_user.F90 b/wrappers/fortran90/examples/spm_user.F90
index da9059c8..b88292da 100644
--- a/wrappers/fortran90/examples/spm_user.F90
+++ b/wrappers/fortran90/examples/spm_user.F90
@@ -1,5 +1,5 @@
!
-! @file spm_user.f90
+! @file spm_user.F90
!
! Fortran 90 example using a laplacian matrix.
!
--
GitLab