Fix Doxygen warnings

mgates3 · Jan 22, 2017 · 611a427 · 611a427
1 parent 2892658
commit 611a427
Show file tree

Hide file tree

Showing 41 changed files with 47 additions and 43 deletions.
diff --git a/SRC/cgesv.f b/SRC/cgesv.f
@@ -1,4 +1,4 @@
-*> \brief <b> CGESV computes the solution to system of linear equations A * X = B for GE matrices</b> (simple driver) </b>
+*> \brief <b> CGESV computes the solution to system of linear equations A * X = B for GE matrices (simple driver) </b>
 *
 *  =========== DOCUMENTATION ===========
 *

diff --git a/SRC/cgesvj.f b/SRC/cgesvj.f
@@ -318,6 +318,8 @@
 *> \par References:
 *  ================
 *>
+*> \verbatim
+*>
 *> [1] P. P. M. De Rijk: A one-sided Jacobi algorithm for computing the
 *>    singular value decomposition on a vector computer.
 *>    SIAM J. Sci. Stat. Comp., Vol. 10 (1998), pp. 359-371.

diff --git a/SRC/chegv_2stage.f b/SRC/chegv_2stage.f
@@ -47,7 +47,7 @@
 *> positive definite.
 *> This routine use the 2stage technique for the reduction to tridiagonal
 *> which showed higher performance on recent architecture and for large
-*  sizes N>2000.
+*> sizes N>2000.
 *> \endverbatim
 *
 *  Arguments:

diff --git a/SRC/chetrd_he2hb.f b/SRC/chetrd_he2hb.f
@@ -132,7 +132,7 @@
 *> \verbatim
 *>          LWORK is INTEGER
 *>          The dimension of the array WORK which should be calculated
-*           by a workspace query. LWORK = MAX(1, LWORK_QUERY)
+*>          by a workspace query. LWORK = MAX(1, LWORK_QUERY)
 *>          If LWORK = -1, then a workspace query is assumed; the routine
 *>          only calculates the optimal size of the WORK array, returns
 *>          this value as the first entry of the WORK array, and no error
@@ -222,7 +222,7 @@
 *>
 *>  where tau is a complex scalar, and v is a complex vector with
 *>  v(kd+1:i) = 0 and v(i+kd+1) = 1; v(i+kd+2:n) is stored on exit in
-*   A(i+kd+2:n,i), and tau in TAU(i).
+*>  A(i+kd+2:n,i), and tau in TAU(i).
 *>
 *>  The contents of A on exit are illustrated by the following examples
 *>  with n = 5:

diff --git a/SRC/cunbdb1.f b/SRC/cunbdb1.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/cunbdb2.f b/SRC/cunbdb2.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/cunbdb3.f b/SRC/cunbdb3.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/cunbdb4.f b/SRC/cunbdb4.f
@@ -33,7 +33,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/cunbdb5.f b/SRC/cunbdb5.f
@@ -31,7 +31,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/cunbdb6.f b/SRC/cunbdb6.f
@@ -31,7 +31,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/cuncsd2by1.f b/SRC/cuncsd2by1.f
@@ -39,7 +39,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/dorbdb1.f b/SRC/dorbdb1.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/dorbdb2.f b/SRC/dorbdb2.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/dorbdb3.f b/SRC/dorbdb3.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/dorbdb4.f b/SRC/dorbdb4.f
@@ -33,7 +33,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/dorbdb5.f b/SRC/dorbdb5.f
@@ -31,7 +31,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/dorbdb6.f b/SRC/dorbdb6.f
@@ -31,7 +31,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/dorcsd2by1.f b/SRC/dorcsd2by1.f
@@ -36,7 +36,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/dsygv_2stage.f b/SRC/dsygv_2stage.f
@@ -46,7 +46,7 @@
 *> positive definite.
 *> This routine use the 2stage technique for the reduction to tridiagonal
 *> which showed higher performance on recent architecture and for large
-*  sizes N>2000.
+*> sizes N>2000.
 *> \endverbatim
 *
 *  Arguments:

diff --git a/SRC/dsytrd_sy2sb.f b/SRC/dsytrd_sy2sb.f
@@ -132,7 +132,7 @@
 *> \verbatim
 *>          LWORK is INTEGER
 *>          The dimension of the array WORK which should be calculated
-*           by a workspace query. LWORK = MAX(1, LWORK_QUERY)
+*>          by a workspace query. LWORK = MAX(1, LWORK_QUERY)
 *>          If LWORK = -1, then a workspace query is assumed; the routine
 *>          only calculates the optimal size of the WORK array, returns
 *>          this value as the first entry of the WORK array, and no error
@@ -222,7 +222,7 @@
 *>
 *>  where tau is a real scalar, and v is a real vector with
 *>  v(kd+1:i) = 0 and v(i+kd+1) = 1; v(i+kd+2:n) is stored on exit in
-*   A(i+kd+2:n,i), and tau in TAU(i).
+*>  A(i+kd+2:n,i), and tau in TAU(i).
 *>
 *>  The contents of A on exit are illustrated by the following examples
 *>  with n = 5:

diff --git a/SRC/sgetrf2.f b/SRC/sgetrf2.f
@@ -38,7 +38,7 @@
 *>
 *>        [  A11 | A12  ]  where A11 is n1 by n1 and A22 is n2 by n2
 *>    A = [ -----|----- ]  with n1 = min(m,n)/2
-*         [  A21 | A22  ]       n2 = n-n1
+*>        [  A21 | A22  ]       n2 = n-n1
 *>
 *>                                       [ A11 ]
 *> The subroutine calls itself to factor [ --- ],

diff --git a/SRC/sorbdb1.f b/SRC/sorbdb1.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/sorbdb2.f b/SRC/sorbdb2.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/sorbdb3.f b/SRC/sorbdb3.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/sorbdb4.f b/SRC/sorbdb4.f
@@ -33,7 +33,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/sorbdb5.f b/SRC/sorbdb5.f
@@ -31,7 +31,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/sorbdb6.f b/SRC/sorbdb6.f
@@ -31,7 +31,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/sorcsd2by1.f b/SRC/sorcsd2by1.f
@@ -36,7 +36,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/ssygv_2stage.f b/SRC/ssygv_2stage.f
@@ -46,7 +46,7 @@
 *> positive definite.
 *> This routine use the 2stage technique for the reduction to tridiagonal
 *> which showed higher performance on recent architecture and for large
-*  sizes N>2000.
+*> sizes N>2000.
 *> \endverbatim
 *
 *  Arguments:

diff --git a/SRC/ssytrd_sy2sb.f b/SRC/ssytrd_sy2sb.f
@@ -132,7 +132,7 @@
 *> \verbatim
 *>          LWORK is INTEGER
 *>          The dimension of the array WORK which should be calculated
-*           by a workspace query. LWORK = MAX(1, LWORK_QUERY)
+*>          by a workspace query. LWORK = MAX(1, LWORK_QUERY)
 *>          If LWORK = -1, then a workspace query is assumed; the routine
 *>          only calculates the optimal size of the WORK array, returns
 *>          this value as the first entry of the WORK array, and no error
@@ -222,7 +222,7 @@
 *>
 *>  where tau is a real scalar, and v is a real vector with
 *>  v(kd+1:i) = 0 and v(i+kd+1) = 1; v(i+kd+2:n) is stored on exit in
-*   A(i+kd+2:n,i), and tau in TAU(i).
+*>  A(i+kd+2:n,i), and tau in TAU(i).
 *>
 *>  The contents of A on exit are illustrated by the following examples
 *>  with n = 5:

diff --git a/SRC/zgesv.f b/SRC/zgesv.f
@@ -1,4 +1,4 @@
-*> \brief <b> ZGESV computes the solution to system of linear equations A * X = B for GE matrices</b> (simple driver) </b>
+*> \brief <b> ZGESV computes the solution to system of linear equations A * X = B for GE matrices (simple driver) </b>
 *
 *  =========== DOCUMENTATION ===========
 *

diff --git a/SRC/zgesvj.f b/SRC/zgesvj.f
@@ -318,6 +318,8 @@
 *> \par References:
 *  ================
 *>
+*> \verbatim
+*>
 *> [1] P. P. M. De Rijk: A one-sided Jacobi algorithm for computing the
 *>    singular value decomposition on a vector computer.
 *>    SIAM J. Sci. Stat. Comp., Vol. 10 (1998), pp. 359-371.

diff --git a/SRC/zhegv_2stage.f b/SRC/zhegv_2stage.f
@@ -47,7 +47,7 @@
 *> positive definite.
 *> This routine use the 2stage technique for the reduction to tridiagonal
 *> which showed higher performance on recent architecture and for large
-*  sizes N>2000.
+*> sizes N>2000.
 *> \endverbatim
 *
 *  Arguments:

diff --git a/SRC/zhetrd_he2hb.f b/SRC/zhetrd_he2hb.f
@@ -132,7 +132,7 @@
 *> \verbatim
 *>          LWORK is INTEGER
 *>          The dimension of the array WORK which should be calculated
-*           by a workspace query. LWORK = MAX(1, LWORK_QUERY)
+*>          by a workspace query. LWORK = MAX(1, LWORK_QUERY)
 *>          If LWORK = -1, then a workspace query is assumed; the routine
 *>          only calculates the optimal size of the WORK array, returns
 *>          this value as the first entry of the WORK array, and no error
@@ -222,7 +222,7 @@
 *>
 *>  where tau is a complex scalar, and v is a complex vector with
 *>  v(kd+1:i) = 0 and v(i+kd+1) = 1; v(i+kd+2:n) is stored on exit in
-*   A(i+kd+2:n,i), and tau in TAU(i).
+*>  A(i+kd+2:n,i), and tau in TAU(i).
 *>
 *>  The contents of A on exit are illustrated by the following examples
 *>  with n = 5:

diff --git a/SRC/zunbdb1.f b/SRC/zunbdb1.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/zunbdb2.f b/SRC/zunbdb2.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/zunbdb3.f b/SRC/zunbdb3.f
@@ -32,7 +32,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/zunbdb4.f b/SRC/zunbdb4.f
@@ -33,7 +33,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/zunbdb5.f b/SRC/zunbdb5.f
@@ -31,7 +31,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/zunbdb6.f b/SRC/zunbdb6.f
@@ -31,7 +31,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>

diff --git a/SRC/zuncsd2by1.f b/SRC/zuncsd2by1.f
@@ -39,7 +39,7 @@
 *
 *
 *> \par Purpose:
-*> =============
+*  =============
 *>
 *>\verbatim
 *>