Integrating Doxygen in comments

1 files changed, 130 insertions, 66 deletions

diff --git a/SRC/dlantb.f b/SRC/dlantb.f
index 7c2c023e..934fdcee 100644
--- a/SRC/dlantb.f
+++ b/SRC/dlantb.f
@@ -1,86 +1,150 @@
-      DOUBLE PRECISION FUNCTION DLANTB( NORM, UPLO, DIAG, N, K, AB,
-     $                 LDAB, WORK )
+*> \brief \b DLANTB
 *
-*  -- LAPACK auxiliary routine (version 3.2) --
-*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
-*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
-*     November 2006
+*  =========== DOCUMENTATION ===========
 *
-*     .. Scalar Arguments ..
-      CHARACTER          DIAG, NORM, UPLO
-      INTEGER            K, LDAB, N
-*     ..
-*     .. Array Arguments ..
-      DOUBLE PRECISION   AB( LDAB, * ), WORK( * )
-*     ..
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
 *
+*  Definition
+*  ==========
+*
+*       DOUBLE PRECISION FUNCTION DLANTB( NORM, UPLO, DIAG, N, K, AB,
+*                        LDAB, WORK )
+* 
+*       .. Scalar Arguments ..
+*       CHARACTER          DIAG, NORM, UPLO
+*       INTEGER            K, LDAB, N
+*       ..
+*       .. Array Arguments ..
+*       DOUBLE PRECISION   AB( LDAB, * ), WORK( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  DLANTB  returns the value of the one norm,  or the Frobenius norm, or
-*  the  infinity norm,  or the element of  largest absolute value  of an
-*  n by n triangular band matrix A,  with ( k + 1 ) diagonals.
-*
-*  Description
-*  ===========
-*
-*  DLANTB returns the value
-*
-*     DLANTB = ( max(abs(A(i,j))), NORM = 'M' or 'm'
-*              (
-*              ( norm1(A),         NORM = '1', 'O' or 'o'
-*              (
-*              ( normI(A),         NORM = 'I' or 'i'
-*              (
-*              ( normF(A),         NORM = 'F', 'f', 'E' or 'e'
-*
-*  where  norm1  denotes the  one norm of a matrix (maximum column sum),
-*  normI  denotes the  infinity norm  of a matrix  (maximum row sum) and
-*  normF  denotes the  Frobenius norm of a matrix (square root of sum of
-*  squares).  Note that  max(abs(A(i,j)))  is not a consistent matrix norm.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> DLANTB  returns the value of the one norm,  or the Frobenius norm, or
+*> the  infinity norm,  or the element of  largest absolute value  of an
+*> n by n triangular band matrix A,  with ( k + 1 ) diagonals.
+*>
+*> Description
+*> ===========
+*>
+*> DLANTB returns the value
+*>
+*>    DLANTB = ( max(abs(A(i,j))), NORM = 'M' or 'm'
+*>             (
+*>             ( norm1(A),         NORM = '1', 'O' or 'o'
+*>             (
+*>             ( normI(A),         NORM = 'I' or 'i'
+*>             (
+*>             ( normF(A),         NORM = 'F', 'f', 'E' or 'e'
+*>
+*> where  norm1  denotes the  one norm of a matrix (maximum column sum),
+*> normI  denotes the  infinity norm  of a matrix  (maximum row sum) and
+*> normF  denotes the  Frobenius norm of a matrix (square root of sum of
+*> squares).  Note that  max(abs(A(i,j)))  is not a consistent matrix norm.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  NORM    (input) CHARACTER*1
-*          Specifies the value to be returned in DLANTB as described
-*          above.
+*> \param[in] NORM
+*> \verbatim
+*>          NORM is CHARACTER*1
+*>          Specifies the value to be returned in DLANTB as described
+*>          above.
+*> \endverbatim
+*>
+*> \param[in] UPLO
+*> \verbatim
+*>          UPLO is CHARACTER*1
+*>          Specifies whether the matrix A is upper or lower triangular.
+*>          = 'U':  Upper triangular
+*>          = 'L':  Lower triangular
+*> \endverbatim
+*>
+*> \param[in] DIAG
+*> \verbatim
+*>          DIAG is CHARACTER*1
+*>          Specifies whether or not the matrix A is unit triangular.
+*>          = 'N':  Non-unit triangular
+*>          = 'U':  Unit triangular
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The order of the matrix A.  N >= 0.  When N = 0, DLANTB is
+*>          set to zero.
+*> \endverbatim
+*>
+*> \param[in] K
+*> \verbatim
+*>          K is INTEGER
+*>          The number of super-diagonals of the matrix A if UPLO = 'U',
+*>          or the number of sub-diagonals of the matrix A if UPLO = 'L'.
+*>          K >= 0.
+*> \endverbatim
+*>
+*> \param[in] AB
+*> \verbatim
+*>          AB is DOUBLE PRECISION array, dimension (LDAB,N)
+*>          The upper or lower triangular band matrix A, stored in the
+*>          first k+1 rows of AB.  The j-th column of A is stored
+*>          in the j-th column of the array AB as follows:
+*>          if UPLO = 'U', AB(k+1+i-j,j) = A(i,j) for max(1,j-k)<=i<=j;
+*>          if UPLO = 'L', AB(1+i-j,j)   = A(i,j) for j<=i<=min(n,j+k).
+*>          Note that when DIAG = 'U', the elements of the array AB
+*>          corresponding to the diagonal elements of the matrix A are
+*>          not referenced, but are assumed to be one.
+*> \endverbatim
+*>
+*> \param[in] LDAB
+*> \verbatim
+*>          LDAB is INTEGER
+*>          The leading dimension of the array AB.  LDAB >= K+1.
+*> \endverbatim
+*>
+*> \param[out] WORK
+*> \verbatim
+*>          WORK is DOUBLE PRECISION array, dimension (MAX(1,LWORK)),
+*>          where LWORK >= N when NORM = 'I'; otherwise, WORK is not
+*>          referenced.
+*> \endverbatim
+*>
 *
-*  UPLO    (input) CHARACTER*1
-*          Specifies whether the matrix A is upper or lower triangular.
-*          = 'U':  Upper triangular
-*          = 'L':  Lower triangular
+*  Authors
+*  =======
 *
-*  DIAG    (input) CHARACTER*1
-*          Specifies whether or not the matrix A is unit triangular.
-*          = 'N':  Non-unit triangular
-*          = 'U':  Unit triangular
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  N       (input) INTEGER
-*          The order of the matrix A.  N >= 0.  When N = 0, DLANTB is
-*          set to zero.
+*> \date November 2011
 *
-*  K       (input) INTEGER
-*          The number of super-diagonals of the matrix A if UPLO = 'U',
-*          or the number of sub-diagonals of the matrix A if UPLO = 'L'.
-*          K >= 0.
+*> \ingroup doubleOTHERauxiliary
 *
-*  AB      (input) DOUBLE PRECISION array, dimension (LDAB,N)
-*          The upper or lower triangular band matrix A, stored in the
-*          first k+1 rows of AB.  The j-th column of A is stored
-*          in the j-th column of the array AB as follows:
-*          if UPLO = 'U', AB(k+1+i-j,j) = A(i,j) for max(1,j-k)<=i<=j;
-*          if UPLO = 'L', AB(1+i-j,j)   = A(i,j) for j<=i<=min(n,j+k).
-*          Note that when DIAG = 'U', the elements of the array AB
-*          corresponding to the diagonal elements of the matrix A are
-*          not referenced, but are assumed to be one.
+*  =====================================================================
+      DOUBLE PRECISION FUNCTION DLANTB( NORM, UPLO, DIAG, N, K, AB,
+     $                 LDAB, WORK )
 *
-*  LDAB    (input) INTEGER
-*          The leading dimension of the array AB.  LDAB >= K+1.
+*  -- LAPACK auxiliary routine (version 3.2) --
+*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
+*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
+*     November 2011
 *
-*  WORK    (workspace) DOUBLE PRECISION array, dimension (MAX(1,LWORK)),
-*          where LWORK >= N when NORM = 'I'; otherwise, WORK is not
-*          referenced.
+*     .. Scalar Arguments ..
+      CHARACTER          DIAG, NORM, UPLO
+      INTEGER            K, LDAB, N
+*     ..
+*     .. Array Arguments ..
+      DOUBLE PRECISION   AB( LDAB, * ), WORK( * )
+*     ..
 *
 * =====================================================================
 *