From 87e9713df2867e89f1edd2f0347fc111f63c1818 Mon Sep 17 00:00:00 2001
From: Mathieu Faverge <mathieu.faverge@inria.fr>
Date: Tue, 6 Feb 2018 18:28:43 +0100
Subject: [PATCH] Update @brief description
---
control/async.c | 2 +-
control/async.h | 6 ++----
control/auxiliary.h | 2 +-
control/compute_z.h | 2 +-
control/context.c | 2 +-
control/context.h | 2 +-
control/control.c | 2 +-
control/descriptor.c | 2 +-
control/descriptor.h | 2 +-
control/gkkleader.h | 24 ++++++++++++------------
control/global.h | 2 +-
control/morse_f77.c | 2 +-
control/morse_f77.h | 2 +-
control/morse_mf77.c | 2 +-
control/morse_zf77.c | 2 +-
control/morsewinthread.c | 2 +-
control/morsewinthread.h | 2 +-
control/primes.h | 11 +++++------
control/tile.c | 2 +-
control/workspace.c | 2 +-
control/workspace.h | 2 +-
control/workspace_z.c | 2 +-
22 files changed, 38 insertions(+), 41 deletions(-)
diff --git a/control/async.c b/control/async.c
index aa25dfb12..b6dee05fd 100644
--- a/control/async.c
+++ b/control/async.c
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon asynchronous management routines
*
* @version 1.0.0
* @author Jakub Kurzak
diff --git a/control/async.h b/control/async.h
index a7be465ab..a2196ffe4 100644
--- a/control/async.h
+++ b/control/async.h
@@ -7,11 +7,9 @@
* @copyright 2012-2014 Bordeaux INP, CNRS (LaBRI UMR 5800), Inria,
* Univ. Bordeaux. All rights reserved.
*
- **/
-/***
- *
+ ***
*
- * MORSE auxiliary routines
+ * @brief Chameleon asynchronous management header
*
* @version 1.0.0
* @author Jakub Kurzak
diff --git a/control/auxiliary.h b/control/auxiliary.h
index 9d6fb207b..b80039a7b 100644
--- a/control/auxiliary.h
+++ b/control/auxiliary.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon auxiliary header
*
* @version 1.0.0
* @author Jakub Kurzak
diff --git a/control/compute_z.h b/control/compute_z.h
index 55368f626..582faf667 100644
--- a/control/compute_z.h
+++ b/control/compute_z.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon computational functions header
*
* @version 1.0.0
* @comment This file has been automatically generated
diff --git a/control/context.c b/control/context.c
index 3b9c6ed99..5b26edd7b 100644
--- a/control/context.c
+++ b/control/context.c
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon context management routines
*
* @version 1.0.0
* @author Jakub Kurzak
diff --git a/control/context.h b/control/context.h
index cf30f03b7..52334df51 100644
--- a/control/context.h
+++ b/control/context.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon context header
*
* @version 1.0.0
* @author Jakub Kurzak
diff --git a/control/control.c b/control/control.c
index 69044f9f5..5dd372f8b 100644
--- a/control/control.c
+++ b/control/control.c
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon control routines
*
* @version 1.0.0
* @author Jakub Kurzak
diff --git a/control/descriptor.c b/control/descriptor.c
index da0e08351..a9a43054e 100644
--- a/control/descriptor.c
+++ b/control/descriptor.c
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon descriptors routines
*
* @version 1.0.0
* @author Mathieu Faverge
diff --git a/control/descriptor.h b/control/descriptor.h
index 42f8b265c..02c6d9730 100644
--- a/control/descriptor.h
+++ b/control/descriptor.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon descriptor header
*
* @version 1.0.0
* @author Jakub Kurzak
diff --git a/control/gkkleader.h b/control/gkkleader.h
index ed299e54f..90ba2bce5 100644
--- a/control/gkkleader.h
+++ b/control/gkkleader.h
@@ -9,16 +9,15 @@
*
***
*
- * @brief Chameleon InPlaceTransformation module
- *
- * This work is the implementation of an inplace transformation
- * based on the GKK algorithm by Gustavson, Karlsson, Kagstrom
- * and its fortran implementation.
- *
+ * @brief Chameleon InPlaceTransformation main module header
* @version 1.0.0
* @author Mathieu Faverge
* @date 2010-11-15
*
+ * This work is the implementation of an inplace transformation
+ * based on the GKK algorithm by Gustavson, Karlsson, Kagstrom
+ * and its fortran implementation.
+ *
**/
#ifndef GKKLEADERS_H
#define GKKLEADERS_H
@@ -27,16 +26,17 @@ int GKK_doublingtable(int x, int m, int emax, int *dt);
int GKK_modpow(int *dt, int e, int m);
int GKK_primroot(int p, int e, primedec_t *pr_p1, int t_p1);
int GKK_multorder(int n, int p, int e, int pe, primedec_t *pr_p1, int t_p1);
-void GKK_prepare(int q, int n, primedec_t *pr_q, int *t,
- primedec_t **pr_pi1, int *t_pi1, int *gi,
+void GKK_prepare(int q, int n, primedec_t *pr_q, int *t,
+ primedec_t **pr_pi1, int *t_pi1, int *gi,
int *Nif, int *Kif, int *dif);
-void GKK_L(int t, primedec_t *pr_q, int *fi, int *Kif, int *dif,
+void GKK_L(int t, primedec_t *pr_q, int *fi, int *Kif, int *dif,
int *Li, int *diLi, int *cl, int *nl);
-void GKK_precompute_terms(int q, primedec_t *pr_q, int t, int *gi,
+void GKK_precompute_terms(int q, primedec_t *pr_q, int t, int *gi,
int *diLi, int *rp, int *Mg, int nMg);
void GKK_BalanceLoad(int thrdnbr, int *Tp, int *leaders, int nleaders, int L);
-void GKK_output_tables(int m, int n, int q, primedec_t *pr_q, int t,
+void GKK_output_tables(int m, int n, int q, primedec_t *pr_q, int t,
int *gi, int *Nif, int *Kif, int *dif);
-int GKK_getLeaderNbr(int me, int ne, int *nleaders, int **leaders);
+int GKK_getLeaderNbr(int me, int ne, int *nleaders, int **leaders);
+
#endif /* GKKLEADERS_H */
diff --git a/control/global.h b/control/global.h
index 359f39e9a..50fbcbf92 100644
--- a/control/global.h
+++ b/control/global.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon global variables header
*
* @version 1.0.0
* @author Jakub Kurzak
diff --git a/control/morse_f77.c b/control/morse_f77.c
index acc2f80a4..b0cec40da 100644
--- a/control/morse_f77.c
+++ b/control/morse_f77.c
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon Fortran77 interface
*
* @version 1.0.0
* @author Bilel Hadri
diff --git a/control/morse_f77.h b/control/morse_f77.h
index 65dd47a08..7b8df9413 100644
--- a/control/morse_f77.h
+++ b/control/morse_f77.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon Fortran names
+ * @brief Chameleon Fortran77 naming macros
*
* @version 1.0.0
* @author Florent Pruvost
diff --git a/control/morse_mf77.c b/control/morse_mf77.c
index 7bd91faac..e1875b1df 100644
--- a/control/morse_mf77.c
+++ b/control/morse_mf77.c
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon mixed-precision computational routines
+ * @brief Chameleon Fortran77 interface for mixed-precision computational routines
*
* @version 1.0.0
* @author Bilel Hadri
diff --git a/control/morse_zf77.c b/control/morse_zf77.c
index f01952f58..2b75de7ca 100644
--- a/control/morse_zf77.c
+++ b/control/morse_zf77.c
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon computational routines
+ * @brief Chameleon Fortran77 computational routines
*
* @version 1.0.0
* @comment This file has been automatically generated
diff --git a/control/morsewinthread.c b/control/morsewinthread.c
index 90b92918b..52390f7a5 100644
--- a/control/morsewinthread.c
+++ b/control/morsewinthread.c
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon thread routines
+ * @brief Chameleon windows threads interface
*
* @version 1.0.0
* @author Piotr Luszczek
diff --git a/control/morsewinthread.h b/control/morsewinthread.h
index e094f0d30..f4e261425 100644
--- a/control/morsewinthread.h
+++ b/control/morsewinthread.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon thread routines
+ * @brief Chameleon Windows thread interface header
*
* @version 1.0.0
* @author Piotr Luszczek
diff --git a/control/primes.h b/control/primes.h
index a8c2b9e29..0bb6660d3 100644
--- a/control/primes.h
+++ b/control/primes.h
@@ -9,17 +9,16 @@
*
***
*
- * @brief Chameleon InPlaceTransformation module
- *
- * This work is the implementation of an inplace transformation
- * based on the GKK algorithm by Gustavson, Karlsson, Kagstrom
- * and its fortran implementation.
- *
+ * @brief Chameleon InPlaceTransformation prime numbers module header
* @version 1.0.0
* @author Mathieu Faverge
* @author Cedric Castagnede
* @date 2010-11-15
*
+ * This work is the implementation of an inplace transformation
+ * based on the GKK algorithm by Gustavson, Karlsson, Kagstrom
+ * and its fortran implementation.
+ *
**/
#ifndef PRIMES_H
#define PRIMES_H
diff --git a/control/tile.c b/control/tile.c
index 9ddba0a2b..c32bd077e 100644
--- a/control/tile.c
+++ b/control/tile.c
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon layout conversion wrappers
*
* @version 1.0.0
* @author Jakub Kurzak
diff --git a/control/workspace.c b/control/workspace.c
index bcc6edd6d..73c2308b3 100644
--- a/control/workspace.c
+++ b/control/workspace.c
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon workspace routines
*
* @version 1.0.0
* @author Mathieu Faverge
diff --git a/control/workspace.h b/control/workspace.h
index b603b287b..f8535feac 100644
--- a/control/workspace.h
+++ b/control/workspace.h
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon workspace header
*
* @version 1.0.0
* @author Jakub Kurzak
diff --git a/control/workspace_z.c b/control/workspace_z.c
index fdbca6aea..d0aab7d18 100644
--- a/control/workspace_z.c
+++ b/control/workspace_z.c
@@ -9,7 +9,7 @@
*
***
*
- * @brief Chameleon auxiliary routines
+ * @brief Chameleon precision dependent workspace routines
*
* @version 1.0.0
* @comment This file has been automatically generated
--
GitLab