enrich documentation

ecrc · Jan 20, 2020 · f1ebe71 · f1ebe71
1 parent ccd1140
commit f1ebe71
Show file tree

Hide file tree

Showing 108 changed files with 1,336 additions and 3,326 deletions.
diff --git a/Jenkinsfile b/Jenkinsfile
@@ -160,4 +160,20 @@ AL4SAN
             }
         }
     }
+    post {
+        //always {
+        //}
+        //success {
+        //}
+        //unstable {
+        //}
+        //failure {
+        //}
+         unstable {
+             emailext body: "${env.JOB_NAME} - Please go to ${env.BUILD_URL}", subject: "Jenkins Pipeline build is UNSTABLE", recipientProviders: [culprits()]
+         }
+         failure {
+             emailext body: "${env.JOB_NAME} - Please go to ${env.BUILD_URL}", subject: "Jenkins Pipeline build FAILED", recipientProviders: [culprits(),requestor()]
+         }
+     }
 }
diff --git a/control/CMakeLists.txt b/control/CMakeLists.txt
@@ -36,7 +36,6 @@ set(AL4SAN_HDRS
     ${CMAKE_CURRENT_SOURCE_DIR}/al4san_auxiliary.h
     ${CMAKE_CURRENT_SOURCE_DIR}/al4san_common.h
     ${CMAKE_CURRENT_SOURCE_DIR}/al4san_context.h
-    ${CMAKE_CURRENT_SOURCE_DIR}/al4san_f77.h
     ${CMAKE_CURRENT_SOURCE_DIR}/al4san_descriptor.h
     )
 

diff --git a/control/al4san_async.h b/control/al4san_async.h
@@ -8,26 +8,16 @@
  *                      Univ. Bordeaux. All rights reserved.
  * @copyright 2018 King Abdullah University of Science and Technology (KAUST).
  *                     All rights reserved.
- *
+ * @brief AL4SAN asynchronous routines
  ***
- * author Jakub Kurzak
- * author Cedric Castagnede
- * date 2010-11-15
- *
+ * @author Jakub Kurzak
+ * @author Cedric Castagnede
+ * @date 2010-11-15
+ * @version 1.0.0
+ * @author Rabab Alomairy
+ * @date 2018-10-18
  */
 
-  /**
-   *
-   * @brief AL4SAN asynchronous routines
-   *
-   *  AL4SAN is a software package provided by King Abdullah University of Science and Technology (KAUST)
-   *
-   * @version 1.0.0
-   * @author Rabab Alomairy
-   * @date 2018-10-18
-   *
-   **/
-
 #ifndef _AL4SAN_ASYNC_H_
 #define _AL4SAN_ASYNC_H_
 

diff --git a/control/al4san_auxiliary.h b/control/al4san_auxiliary.h
@@ -11,24 +11,17 @@
  *
  ***
  * *
- * author Jakub Kurzak
- * author Piotr Luszczek
- * author Emmanuel Agullo
- * author Cedric Castagnede
- * date 2010-11-15
- *
- */
-  /**
-   *
-   * @brief AL4SAN auxiliary routines
-   *
-   *  AL4SAN is a software package provided by King Abdullah University of Science and Technology (KAUST)
-   *
+ * @brief AL4SAN auxiliary routines
+ *  AL4SAN is a software package provided by King Abdullah University of Science and Technology (KAUST)
+ * @author Jakub Kurzak
+ * @author Piotr Luszczek
+ * @author Emmanuel Agullo
+ * @author Cedric Castagnede
+ * @date 2010-11-15
    * @version 1.0.0
    * @author Rabab Alomairy
    * @date 2018-10-18
-   *
-   **/
+ */
 #ifndef _AL4SAN_AUXILIARY_H_
 #define _AL4SAN_AUXILIARY_H_
 
@@ -47,13 +40,6 @@ void al4san_fatal_error  (const char *func_name, const char* msg_text);
 int  al4san_rank         (AL4SAN_context_t *al4san);
 int  al4san_tune         (AL4SAN_enum func, int M, int N, int NRHS);
 
-/**
- *  API routines
- */
-int  AL4SAN_Version      (int *ver_major, int *ver_minor, int *ver_micro);
-int  AL4SAN_Element_Size (int type);
-int  AL4SAN_My_Mpi_Rank  (void);
-
 #ifdef __cplusplus
 }
 #endif

diff --git a/control/al4san_common.h b/control/al4san_common.h
@@ -9,24 +9,17 @@
  * @copyright 2018 King Abdullah University of Science and Technology (KAUST).
  *                     All rights reserved.
  *
+ * @brief AL4SAN common headers
+ *  AL4SAN is a software package provided by King Abdullah University of Science and Technology (KAUST)
  ***
   *
- * author Mathieu Faverge
- * author Cedric Castagnede
- * date 2012-09-15
- *
+ * @author Mathieu Faverge
+ * @author Cedric Castagnede
+ * @date 2012-09-15
+ * @version 1.0.1
+ * @author Rabab Alomairy
+ * @date 2019-02-06
  */
-  /**
-   *
-   * @brief AL4SAN common headers
-   *
-   *  AL4SAN is a software package provided by King Abdullah University of Science and Technology (KAUST)
-   *
-   * @version 1.0.1
-   * @author Rabab Alomairy
-   * @date 2019-02-06
-   *
-   **/
 #ifndef _AL4SAN_COMMON_H_
 #define _AL4SAN_COMMON_H_
 

diff --git a/control/al4san_descriptor.h b/control/al4san_descriptor.h
@@ -8,27 +8,18 @@
  *                      Univ. Bordeaux. All rights reserved.
  *
  ***
- *
  * @brief Al4san descriptor header
  *
  * @version 1.0.1
  * @author Jakub Kurzak
  * @author Mathieu Faverge
  * @author Cedric Castagnede
  * @date 2019-02-06
+ * @version 1.0.1
+ * @author Rabab Alomairy
+ * @date 2019-02-06
  *
- */
-  /**
-   *
-   * @brief AL4SAN descriptor header
-   *
-   *  AL4SAN is a software package provided by King Abdullah University of Science and Technology (KAUST)
-   *
-   * @version 1.0.1
-   * @author Rabab Alomairy
-   * @date 2019-02-06
-   *
-   **/
+ **/
 #ifndef _AL4SAN_DESCRIPTOR_H_
 #define _AL4SAN_DESCRIPTOR_H_
 

diff --git a/control/async.c b/control/async.c
@@ -10,29 +10,20 @@
  *                     All rights reserved.
  ***
  * *
- * author Jakub Kurzak
- * author Mathieu Faverge
- * author Cedric Castagnede
- * date 2012-09-15
- *
- ***
+ * @brief AL4SAN asynchronous routines
+ * @author Jakub Kurzak
+ * @author Mathieu Faverge
+ * @author Cedric Castagnede
+ * 2date 2012-09-15
+ * @version 1.0.1
+ * @author Rabab Alomairy
+ * @date 2019-02-06
  *
  * @defgroup Sequences
  * @brief Group routines exposed to users to handle asynchronous tasks execution
  *
  */
 
-  /**
-   *
-   * @brief AL4SAN asynchronous routines
-   *
-   *  AL4SAN is a software package provided by King Abdullah University of Science and Technology (KAUST)
-   *
-   * @version 1.0.1
-   * @author Rabab Alomairy
-   * @date 2019-02-06
-   *
-   **/
 #include <stdlib.h>
 #include "control/al4san_common.h"
 #include "al4san/runtime.h"

diff --git a/control/auxiliary.c b/control/auxiliary.c
@@ -10,30 +10,25 @@
  *                     All rights reserved.
  *
  ***
- *
- * author Jakub Kurzak
- * author Piotr Luszczek
- * author Emmanuel Agullo
- * author Cedric Castagnede
- * date 2012-09-15
- *
+ * @brief AL4SAN auxiliary routines
+ *
+ *  AL4SAN is a software package provided by King Abdullah University of Science and Technology (KAUST)
+ *
+ * @author Jakub Kurzak
+ * @author Piotr Luszczek
+ * @author Emmanuel Agullo
+ * @author Cedric Castagnede
+ * @date 2012-09-15
+ * @version 1.0.0
+ * @author Rabab Alomairy
+ * @date 2018-10-18 
+*
  ***
  *
  * @defgroup Auxiliary
  * @brief Group auxiliary routines exposed to users
  *
  */
-  /**
-   *
-   * @brief AL4SAN auxiliary routines
-   *
-   *  AL4SAN is a software package provided by King Abdullah University of Science and Technology (KAUST)
-   *
-   * @version 1.0.0
-   * @author Rabab Alomairy
-   * @date 2018-10-18
-   *
-   **/
 #include "control/al4san_common.h"
 #include "control/al4san_auxiliary.h"
 

diff --git a/control/context.c b/control/context.c
@@ -10,26 +10,20 @@
  *                     All rights reserved.
  *
  ***
+ * @brief AL4SAN context management  routines
+ *
+ *  AL4SAN is a software package provided by King Abdullah University of Science and Technology (KAUST)
  *
  *
  * author Jakub Kurzak
  * author Mathieu Faverge
  * author Cedric Castagnede
  * date 2012-09-15
- *
+ * @version 1.0.0
+ * @author Rabab Alomairy
+ * @date 2018-10-18
  *
  */
-  /**
-   *
-   * @brief AL4SAN context management  routines
-   *
-   *  AL4SAN is a software package provided by King Abdullah University of Science and Technology (KAUST)
-   *
-   * @version 1.0.0
-   * @author Rabab Alomairy
-   * @date 2018-10-18
-   *
-   **/
 
 #include <stdlib.h>
 #include <pthread.h>