From 6c0ac13b0e7ace450435082d285cfe137d9269cd Mon Sep 17 00:00:00 2001
From: Florent Pruvost <florent.pruvost@inria.fr>
Date: Fri, 12 Oct 2018 11:21:28 +0200
Subject: [PATCH] fix headers in examples

---
 example/CMakeLists.txt                        |  1 +
 .../lapack_to_chameleon/lapack_to_chameleon.h |  6 ++---
 example/lapack_to_chameleon/step0.c           |  2 +-
 example/lapack_to_chameleon/step0.h           |  6 ++---
 example/lapack_to_chameleon/step1.h           |  6 ++---
 example/lapack_to_chameleon/step2.h           |  6 ++---
 example/lapack_to_chameleon/step3.h           |  6 ++---
 example/lapack_to_chameleon/step4.h           |  6 ++---
 example/lapack_to_chameleon/step5.h           |  6 ++---
 example/lapack_to_chameleon/step6.h           |  6 ++---
 example/lapack_to_chameleon/step7.h           |  6 ++---
 example/link_chameleon/CMakeLists.txt         | 25 +++++++++++++++++--
 example/link_chameleon/link_chameleon.c       | 18 +++++++++++++
 example/link_chameleon/link_chameleon.f90     | 15 ++++++++++-
 example/out_of_core/out_of_core.h             |  6 ++---
 15 files changed, 87 insertions(+), 34 deletions(-)

diff --git a/example/CMakeLists.txt b/example/CMakeLists.txt
index 538cc6cc9..64baacbca 100755
--- a/example/CMakeLists.txt
+++ b/example/CMakeLists.txt
@@ -17,6 +17,7 @@
 #     Univ. of California Berkeley,
 #     Univ. of Colorado Denver.
 #
+#  @version 1.0.0
 #  @date 2014-10-17
 #
 ###
diff --git a/example/lapack_to_chameleon/lapack_to_chameleon.h b/example/lapack_to_chameleon/lapack_to_chameleon.h
index dc085b948..43b635231 100644
--- a/example/lapack_to_chameleon/lapack_to_chameleon.h
+++ b/example/lapack_to_chameleon/lapack_to_chameleon.h
@@ -16,8 +16,8 @@
  * @date 2014-10-29
  *
  */
-#ifndef LAPACK_TO_CHAMELEON_H
-#define LAPACK_TO_CHAMELEON_H
+#ifndef _lapack_to_chameleon_h_
+#define _lapack_to_chameleon_h_
 
 #if defined( _WIN32 ) || defined( _WIN64 )
 #define int64_t __int64
@@ -66,4 +66,4 @@ static int startswith(const char *s, const char *prefix) {
 /* define some tools to time the program */
 #include <chameleon/timer.h>
 
-#endif /* LAPACK_TO_CHAMELEON_H */
+#endif /* _lapack_to_chameleon_h_ */
diff --git a/example/lapack_to_chameleon/step0.c b/example/lapack_to_chameleon/step0.c
index ecf7d076f..e2da77da1 100644
--- a/example/lapack_to_chameleon/step0.c
+++ b/example/lapack_to_chameleon/step0.c
@@ -4,7 +4,7 @@
  *
  * @copyright 2009-2014 The University of Tennessee and The University of
  *                      Tennessee Research Foundation. All rights reserved.
- * @copyright 2012-2014 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
+ * @copyright 2012-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
  *                      Univ. Bordeaux. All rights reserved.
  *
  ***
diff --git a/example/lapack_to_chameleon/step0.h b/example/lapack_to_chameleon/step0.h
index 7a7812dc2..4d22f7893 100644
--- a/example/lapack_to_chameleon/step0.h
+++ b/example/lapack_to_chameleon/step0.h
@@ -16,8 +16,8 @@
  * @date 2014-10-29
  *
  */
-#ifndef STEP0_H
-#define STEP0_H
+#ifndef _step0_h_
+#define _step0_h_
 
 /* Common include for all steps of the tutorial */
 #include "lapack_to_chameleon.h"
@@ -242,4 +242,4 @@ static void CORE_dplrnt( int m, int n, double *A, int lda,
     }
 }
 
-#endif /* STEP0_H */
+#endif /* _step0_h_ */
diff --git a/example/lapack_to_chameleon/step1.h b/example/lapack_to_chameleon/step1.h
index 1f13f810e..92673eb0a 100644
--- a/example/lapack_to_chameleon/step1.h
+++ b/example/lapack_to_chameleon/step1.h
@@ -16,8 +16,8 @@
  * @date 2014-10-29
  *
  */
-#ifndef STEP1_H
-#define STEP1_H
+#ifndef _step1_h_
+#define _step1_h_
 
 /* Common include for all steps of the tutorial */
 #include "lapack_to_chameleon.h"
@@ -119,4 +119,4 @@ static void print_header(char *prog_name, int * iparam) {
     return;
 }
 
-#endif /* STEP1_H */
+#endif /* _step1_h_ */
diff --git a/example/lapack_to_chameleon/step2.h b/example/lapack_to_chameleon/step2.h
index 990c07891..383355257 100644
--- a/example/lapack_to_chameleon/step2.h
+++ b/example/lapack_to_chameleon/step2.h
@@ -16,8 +16,8 @@
  * @date 2014-10-29
  *
  */
-#ifndef STEP2_H
-#define STEP2_H
+#ifndef _step2_h_
+#define _step2_h_
 
 /* Common include for all steps of the tutorial */
 #include "lapack_to_chameleon.h"
@@ -119,4 +119,4 @@ static void print_header(char *prog_name, int * iparam) {
     return;
 }
 
-#endif /* STEP2_H */
+#endif /* _step2_h_ */
diff --git a/example/lapack_to_chameleon/step3.h b/example/lapack_to_chameleon/step3.h
index b0862e332..edc2385a8 100644
--- a/example/lapack_to_chameleon/step3.h
+++ b/example/lapack_to_chameleon/step3.h
@@ -16,8 +16,8 @@
  * @date 2014-10-29
  *
  */
-#ifndef STEP3_H
-#define STEP3_H
+#ifndef _step3_h_
+#define _step3_h_
 
 /* Common include for all steps of the tutorial */
 #include "lapack_to_chameleon.h"
@@ -197,4 +197,4 @@ inline static int user_getrankof_zero(const CHAM_desc_t *A, int m, int n)
     return 0;
 }
 
-#endif /* STEP3_H */
+#endif /* _step3_h_ */
diff --git a/example/lapack_to_chameleon/step4.h b/example/lapack_to_chameleon/step4.h
index 8aed88b04..eab5928ca 100644
--- a/example/lapack_to_chameleon/step4.h
+++ b/example/lapack_to_chameleon/step4.h
@@ -16,8 +16,8 @@
  * @date 2014-10-29
  *
  */
-#ifndef STEP4_H
-#define STEP4_H
+#ifndef _step4_h_
+#define _step4_h_
 
 /* Common include for all steps of the tutorial */
 #include "lapack_to_chameleon.h"
@@ -119,4 +119,4 @@ static void print_header(char *prog_name, int * iparam) {
     return;
 }
 
-#endif /* STEP4_H */
+#endif /* _step4_h_ */
diff --git a/example/lapack_to_chameleon/step5.h b/example/lapack_to_chameleon/step5.h
index d1bcbeafd..ab3816866 100644
--- a/example/lapack_to_chameleon/step5.h
+++ b/example/lapack_to_chameleon/step5.h
@@ -16,8 +16,8 @@
  * @date 2014-10-29
  *
  */
-#ifndef STEP5_H
-#define STEP5_H
+#ifndef _step5_h_
+#define _step5_h_
 
 /* Common include for all steps of the tutorial */
 #include "lapack_to_chameleon.h"
@@ -134,4 +134,4 @@ static void print_header(char *prog_name, int * iparam) {
     return;
 }
 
-#endif /* STEP5_H */
+#endif /* _step5_h_ */
diff --git a/example/lapack_to_chameleon/step6.h b/example/lapack_to_chameleon/step6.h
index f52830d97..3893a87ab 100644
--- a/example/lapack_to_chameleon/step6.h
+++ b/example/lapack_to_chameleon/step6.h
@@ -16,8 +16,8 @@
  * @date 2014-10-29
  *
  */
-#ifndef STEP6_H
-#define STEP6_H
+#ifndef _step6_h_
+#define _step6_h_
 
 /* Common include for all steps of the tutorial */
 #include "lapack_to_chameleon.h"
@@ -150,4 +150,4 @@ static void print_header(char *prog_name, int * iparam) {
     return;
 }
 
-#endif /* STEP6_H */
+#endif /* _step6_h_ */
diff --git a/example/lapack_to_chameleon/step7.h b/example/lapack_to_chameleon/step7.h
index cd79e06db..7515ec8b5 100644
--- a/example/lapack_to_chameleon/step7.h
+++ b/example/lapack_to_chameleon/step7.h
@@ -17,8 +17,8 @@
  * @date 2016-09-05
  *
  */
-#ifndef step7_H
-#define step7_H
+#ifndef _step7_h_
+#define _step7_h_
 
 /* Common include for all steps of the tutorial */
 #include "lapack_to_chameleon.h"
@@ -177,4 +177,4 @@ static void print_header(char *prog_name, int * iparam) {
     return;
 }
 
-#endif /* step7_H */
+#endif /* _step7_h_ */
diff --git a/example/link_chameleon/CMakeLists.txt b/example/link_chameleon/CMakeLists.txt
index 13d1acd44..cbf4381eb 100644
--- a/example/link_chameleon/CMakeLists.txt
+++ b/example/link_chameleon/CMakeLists.txt
@@ -1,5 +1,26 @@
-### Main CMakeLists.txt for project link_chameleon
-
+###
+#
+# @file CMakeLists.txt
+#
+# @copyright 2009-2014 The University of Tennessee and The University of
+#                      Tennessee Research Foundation. All rights reserved.
+# @copyright 2012-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
+#                      Univ. Bordeaux. All rights reserved.
+#
+###
+#
+#  @project CHAMELEON
+#  CHAMELEON is a software package provided by:
+#     Inria Bordeaux - Sud-Ouest,
+#     Univ. of Tennessee,
+#     King Abdullah Univesity of Science and Technology
+#     Univ. of California Berkeley,
+#     Univ. of Colorado Denver.
+#
+#  @version 1.0.0
+#  @date 2014-10-17
+#
+###
 cmake_minimum_required(VERSION 2.8)
 project(LINK_CHAMELEON Fortran C CXX)
 
diff --git a/example/link_chameleon/link_chameleon.c b/example/link_chameleon/link_chameleon.c
index b828331f9..ff20e16a0 100644
--- a/example/link_chameleon/link_chameleon.c
+++ b/example/link_chameleon/link_chameleon.c
@@ -1,3 +1,21 @@
+/**
+ *
+ * @file link_chameleon.c
+ *
+ * @copyright 2009-2014 The University of Tennessee and The University of
+ *                      Tennessee Research Foundation. All rights reserved.
+ * @copyright 2012-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
+ *                      Univ. Bordeaux. All rights reserved.
+ *
+ ***
+ *
+ * @brief Chameleon link_chameleon example
+ *
+ * @version 1.0.0
+ * @author Florent Pruvost
+ * @date 2014-10-29
+ *
+ */
 #include <math.h>
 #include <stdio.h>
 #include <stdlib.h>
diff --git a/example/link_chameleon/link_chameleon.f90 b/example/link_chameleon/link_chameleon.f90
index 2a5722ced..e58eaf9da 100644
--- a/example/link_chameleon/link_chameleon.f90
+++ b/example/link_chameleon/link_chameleon.f90
@@ -1,4 +1,17 @@
-
+!!!
+!
+! @file link_chameleon.f90
+!
+!  CHAMELEON Fortran 90 interfaces using Fortran 2003 ISO C bindings
+!  CHAMELEON is a software package provided by Univ. of Tennessee,
+!  Univ. of California Berkeley and Univ. of Colorado Denver
+!
+! @copyright 2012-2018 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
+!                      Univ. Bordeaux. All rights reserved.
+!
+! @version 1.0.0
+! @author Florent Pruvost
+! @date 2011-09-15
 program fortran_example
     implicit none
     include 'chameleon_fortran.h'
diff --git a/example/out_of_core/out_of_core.h b/example/out_of_core/out_of_core.h
index d86f9c132..c9bcea306 100644
--- a/example/out_of_core/out_of_core.h
+++ b/example/out_of_core/out_of_core.h
@@ -16,8 +16,8 @@
  * @date 2016-08-23
  *
  */
-#ifndef OOC_H
-#define OOC_H
+#ifndef _out_of_core_h_
+#define _out_of_core_h_
 
 #include <math.h>
 #include <stdio.h>
@@ -193,4 +193,4 @@ print_o_direct_wont_work(void) {
                     "multiples of 4096. Tip : chose 'n' and 'nb' as both multiples of 32.\n");
 }
 
-#endif /* OOC_H */
+#endif /* _out_of_core_h_ */
-- 
GitLab