From c620aa90aa10badd4fb0acc9b2847ce8bc80a6a4 Mon Sep 17 00:00:00 2001
From: Mathieu Faverge <mathieu.faverge@inria.fr>
Date: Tue, 6 Feb 2018 18:59:13 +0100
Subject: [PATCH] Update @brief description in include
---
include/chameleon/chameleon_timer.h | 38 +++++++++++++++--------------
include/chameleon/morse_constants.h | 2 +-
include/chameleon/morse_fortran.h | 10 ++------
include/chameleon/morse_kernels.h | 8 +++---
include/chameleon/morse_runtime.h | 7 ++----
include/chameleon/morse_simulate.h | 2 +-
include/chameleon/morse_struct.h | 2 +-
include/chameleon/morse_tasks.h | 8 +++---
include/chameleon/morse_tasks_z.h | 2 +-
include/chameleon/morse_tasks_zc.h | 2 +-
include/chameleon/morse_types.h | 2 +-
include/chameleon/morse_z.h | 2 +-
include/chameleon/morse_zc.h | 2 +-
13 files changed, 40 insertions(+), 47 deletions(-)
diff --git a/include/chameleon/chameleon_timer.h b/include/chameleon/chameleon_timer.h
index 1e248404f..996a0b693 100644
--- a/include/chameleon/chameleon_timer.h
+++ b/include/chameleon/chameleon_timer.h
@@ -9,6 +9,8 @@
*
* @version 1.0.0
*
+ * @brief Chameleon timer
+ *
* Provide a simple timer for examples and runtimes which do not provide their
* own timer.
*
@@ -40,29 +42,29 @@ gettimeofday(struct timeval* tv, struct timezone* tz)
static int tzflag;
if (NULL != tv)
- {
- GetSystemTimeAsFileTime(&ft);
- tmpres |= ft.dwHighDateTime;
- tmpres <<= 32;
- tmpres |= ft.dwLowDateTime;
+ {
+ GetSystemTimeAsFileTime(&ft);
+ tmpres |= ft.dwHighDateTime;
+ tmpres <<= 32;
+ tmpres |= ft.dwLowDateTime;
- /*converting file time to unix epoch*/
- tmpres /= 10; /*convert into microseconds*/
- tmpres -= DELTA_EPOCH_IN_MICROSECS;
+ /*converting file time to unix epoch*/
+ tmpres /= 10; /*convert into microseconds*/
+ tmpres -= DELTA_EPOCH_IN_MICROSECS;
- tv->tv_sec = (long)(tmpres / 1000000UL);
- tv->tv_usec = (long)(tmpres % 1000000UL);
- }
+ tv->tv_sec = (long)(tmpres / 1000000UL);
+ tv->tv_usec = (long)(tmpres % 1000000UL);
+ }
if (NULL != tz)
+ {
+ if (!tzflag)
{
- if (!tzflag)
- {
- _tzset();
- tzflag++;
- }
- tz->tz_minuteswest = _timezone / 60;
- tz->tz_dsttime = _daylight;
+ _tzset();
+ tzflag++;
}
+ tz->tz_minuteswest = _timezone / 60;
+ tz->tz_dsttime = _daylight;
+ }
return 0;
}
diff --git a/include/chameleon/morse_constants.h b/include/chameleon/morse_constants.h
index 1c127bb37..01f412b95 100644
--- a/include/chameleon/morse_constants.h
+++ b/include/chameleon/morse_constants.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon header
+ * @brief Chameleon global constants
*
* @version 1.0.0
* @author Cedric Augonnet
diff --git a/include/chameleon/morse_fortran.h b/include/chameleon/morse_fortran.h
index 3f8c2cf09..b1fb41aec 100644
--- a/include/chameleon/morse_fortran.h
+++ b/include/chameleon/morse_fortran.h
@@ -1,4 +1,4 @@
-!!!
+!**
!
! -- Inria
! -- (C) Copyright 2012
@@ -33,15 +33,9 @@
! The fact that you are presently reading this means that you have had
! knowledge of the CeCILL-B license and that you accept its terms.
!
-!!!
-
!**
!
-!
-! MORSE FORTRAN header
-! MORSE is a software package provided by Univ. of Tennessee,
-! Univ. of California Berkeley and Univ. of Colorado Denver
-!
+! @brief Chameleon Fortran77 header
! @version 1.0.0
! @author Bilel Hadri
! @author Mathieu Faverge
diff --git a/include/chameleon/morse_kernels.h b/include/chameleon/morse_kernels.h
index ea8a1f19c..842786596 100644
--- a/include/chameleon/morse_kernels.h
+++ b/include/chameleon/morse_kernels.h
@@ -9,12 +9,12 @@
*
***
*
- * @brief Chameleon codelets kernel
+ * @brief Chameleon elementary kernels enum
*
* @version 1.0.0
- * @author Mathieu Faverge
- * @author Cedric Augonnet
- * @date 2011-06-01
+ * @author Mathieu Faverge
+ * @author Cedric Augonnet
+ * @date 2011-06-01
*
**/
#ifndef _MORSE_KERNELS_H_
diff --git a/include/chameleon/morse_runtime.h b/include/chameleon/morse_runtime.h
index 8bbc96918..7ab4e3b23 100644
--- a/include/chameleon/morse_runtime.h
+++ b/include/chameleon/morse_runtime.h
@@ -7,12 +7,9 @@
* @copyright 2012-2017 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
* Univ. Bordeaux. All rights reserved.
*
- * CHAMELEON runtimes API
- *
- * CHAMELEON is a software package provided by Univ. of Tennessee,
- * Univ. of California Berkeley and Univ. of Colorado Denver,
- * and Inria Bordeaux Sud-Ouest
+ ***
*
+ * @brief Chameleon runtimes API
* @version 1.0.0
* @author Mathieu Faverge
* @author Cedric Augonnet
diff --git a/include/chameleon/morse_simulate.h b/include/chameleon/morse_simulate.h
index e55a72939..40db7729f 100644
--- a/include/chameleon/morse_simulate.h
+++ b/include/chameleon/morse_simulate.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon codelets kernel
+ * @brief Chameleon SimGrid simulation header
*
* @version 1.0.0
* @author Florent Pruvost
diff --git a/include/chameleon/morse_struct.h b/include/chameleon/morse_struct.h
index f0ac2cd34..9919d14db 100644
--- a/include/chameleon/morse_struct.h
+++ b/include/chameleon/morse_struct.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon header
+ * @brief Chameleon structures
*
* @version 1.0.0
* @author Cedric Augonnet
diff --git a/include/chameleon/morse_tasks.h b/include/chameleon/morse_tasks.h
index 467177d5b..5babbd1c8 100644
--- a/include/chameleon/morse_tasks.h
+++ b/include/chameleon/morse_tasks.h
@@ -9,12 +9,12 @@
*
***
*
- * @brief Chameleon codelets kernel
+ * @brief Chameleon elementary tasks main header
*
* @version 1.0.0
- * @author Mathieu Faverge
- * @author Cedric Augonnet
- * @date 2011-06-01
+ * @author Mathieu Faverge
+ * @author Cedric Augonnet
+ * @date 2011-06-01
*
**/
#ifndef _MORSE_TASKS_H_
diff --git a/include/chameleon/morse_tasks_z.h b/include/chameleon/morse_tasks_z.h
index abc917060..5e7dbc916 100644
--- a/include/chameleon/morse_tasks_z.h
+++ b/include/chameleon/morse_tasks_z.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon MORSE_Complex64_t elementary tasks header
*
* @version 1.0.0
* @comment This file has been automatically generated
diff --git a/include/chameleon/morse_tasks_zc.h b/include/chameleon/morse_tasks_zc.h
index bb5a67549..3ddd45946 100644
--- a/include/chameleon/morse_tasks_zc.h
+++ b/include/chameleon/morse_tasks_zc.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon complex mixed precision elementary tasks header
*
* @version 1.0.0
* @comment This file has been automatically generated
diff --git a/include/chameleon/morse_types.h b/include/chameleon/morse_types.h
index 73134e1c4..aca77a0ea 100644
--- a/include/chameleon/morse_types.h
+++ b/include/chameleon/morse_types.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon header
+ * @brief Chameleon basic datatypes header
*
* @version 1.0.0
* @author Cedric Augonnet
diff --git a/include/chameleon/morse_z.h b/include/chameleon/morse_z.h
index 8d4923f2a..cee8b9808 100644
--- a/include/chameleon/morse_z.h
+++ b/include/chameleon/morse_z.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon header file for double _Complex routines
+ * @brief Chameleon MORSE_complex64_t wrappers
*
* @version 1.0.0
* @comment This file has been automatically generated
diff --git a/include/chameleon/morse_zc.h b/include/chameleon/morse_zc.h
index fd9397104..39e2fbb41 100644
--- a/include/chameleon/morse_zc.h
+++ b/include/chameleon/morse_zc.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon header file for iterative refinement routines
+ * @brief Chameleon mixed precision wrappers header
*
* @version 1.0.0
* @comment This file has been automatically generated
--
GitLab