Integrating Doxygen in comments

1 files changed, 133 insertions, 68 deletions

diff --git a/SRC/zlantr.f b/SRC/zlantr.f
index e2ea5b28..45845dee 100644
--- a/SRC/zlantr.f
+++ b/SRC/zlantr.f
@@ -1,88 +1,153 @@
-      DOUBLE PRECISION FUNCTION ZLANTR( NORM, UPLO, DIAG, M, N, A, LDA,
-     $                 WORK )
+*> \brief \b ZLANTR
 *
-*  -- 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            LDA, M, N
-*     ..
-*     .. Array Arguments ..
-      DOUBLE PRECISION   WORK( * )
-      COMPLEX*16         A( LDA, * )
-*     ..
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
 *
+*       DOUBLE PRECISION FUNCTION ZLANTR( NORM, UPLO, DIAG, M, N, A, LDA,
+*                        WORK )
+* 
+*       .. Scalar Arguments ..
+*       CHARACTER          DIAG, NORM, UPLO
+*       INTEGER            LDA, M, N
+*       ..
+*       .. Array Arguments ..
+*       DOUBLE PRECISION   WORK( * )
+*       COMPLEX*16         A( LDA, * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  ZLANTR  returns the value of the one norm,  or the Frobenius norm, or
-*  the  infinity norm,  or the  element of  largest absolute value  of a
-*  trapezoidal or triangular matrix A.
-*
-*  Description
-*  ===========
-*
-*  ZLANTR returns the value
-*
-*     ZLANTR = ( 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
+*>
+*> ZLANTR  returns the value of the one norm,  or the Frobenius norm, or
+*> the  infinity norm,  or the  element of  largest absolute value  of a
+*> trapezoidal or triangular matrix A.
+*>
+*> Description
+*> ===========
+*>
+*> ZLANTR returns the value
+*>
+*>    ZLANTR = ( 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 ZLANTR as described
-*          above.
+*> \param[in] NORM
+*> \verbatim
+*>          NORM is CHARACTER*1
+*>          Specifies the value to be returned in ZLANTR as described
+*>          above.
+*> \endverbatim
+*>
+*> \param[in] UPLO
+*> \verbatim
+*>          UPLO is CHARACTER*1
+*>          Specifies whether the matrix A is upper or lower trapezoidal.
+*>          = 'U':  Upper trapezoidal
+*>          = 'L':  Lower trapezoidal
+*>          Note that A is triangular instead of trapezoidal if M = N.
+*> \endverbatim
+*>
+*> \param[in] DIAG
+*> \verbatim
+*>          DIAG is CHARACTER*1
+*>          Specifies whether or not the matrix A has unit diagonal.
+*>          = 'N':  Non-unit diagonal
+*>          = 'U':  Unit diagonal
+*> \endverbatim
+*>
+*> \param[in] M
+*> \verbatim
+*>          M is INTEGER
+*>          The number of rows of the matrix A.  M >= 0, and if
+*>          UPLO = 'U', M <= N.  When M = 0, ZLANTR is set to zero.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The number of columns of the matrix A.  N >= 0, and if
+*>          UPLO = 'L', N <= M.  When N = 0, ZLANTR is set to zero.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*>          A is COMPLEX*16 array, dimension (LDA,N)
+*>          The trapezoidal matrix A (A is triangular if M = N).
+*>          If UPLO = 'U', the leading m by n upper trapezoidal part of
+*>          the array A contains the upper trapezoidal matrix, and the
+*>          strictly lower triangular part of A is not referenced.
+*>          If UPLO = 'L', the leading m by n lower trapezoidal part of
+*>          the array A contains the lower trapezoidal matrix, and the
+*>          strictly upper triangular part of A is not referenced.  Note
+*>          that when DIAG = 'U', the diagonal elements of A are not
+*>          referenced and are assumed to be one.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER
+*>          The leading dimension of the array A.  LDA >= max(M,1).
+*> \endverbatim
+*>
+*> \param[out] WORK
+*> \verbatim
+*>          WORK is DOUBLE PRECISION array, dimension (MAX(1,LWORK)),
+*>          where LWORK >= M when NORM = 'I'; otherwise, WORK is not
+*>          referenced.
+*> \endverbatim
+*>
 *
-*  UPLO    (input) CHARACTER*1
-*          Specifies whether the matrix A is upper or lower trapezoidal.
-*          = 'U':  Upper trapezoidal
-*          = 'L':  Lower trapezoidal
-*          Note that A is triangular instead of trapezoidal if M = N.
+*  Authors
+*  =======
 *
-*  DIAG    (input) CHARACTER*1
-*          Specifies whether or not the matrix A has unit diagonal.
-*          = 'N':  Non-unit diagonal
-*          = 'U':  Unit diagonal
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  M       (input) INTEGER
-*          The number of rows of the matrix A.  M >= 0, and if
-*          UPLO = 'U', M <= N.  When M = 0, ZLANTR is set to zero.
+*> \date November 2011
 *
-*  N       (input) INTEGER
-*          The number of columns of the matrix A.  N >= 0, and if
-*          UPLO = 'L', N <= M.  When N = 0, ZLANTR is set to zero.
+*> \ingroup complex16OTHERauxiliary
 *
-*  A       (input) COMPLEX*16 array, dimension (LDA,N)
-*          The trapezoidal matrix A (A is triangular if M = N).
-*          If UPLO = 'U', the leading m by n upper trapezoidal part of
-*          the array A contains the upper trapezoidal matrix, and the
-*          strictly lower triangular part of A is not referenced.
-*          If UPLO = 'L', the leading m by n lower trapezoidal part of
-*          the array A contains the lower trapezoidal matrix, and the
-*          strictly upper triangular part of A is not referenced.  Note
-*          that when DIAG = 'U', the diagonal elements of A are not
-*          referenced and are assumed to be one.
+*  =====================================================================
+      DOUBLE PRECISION FUNCTION ZLANTR( NORM, UPLO, DIAG, M, N, A, LDA,
+     $                 WORK )
 *
-*  LDA     (input) INTEGER
-*          The leading dimension of the array A.  LDA >= max(M,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 >= M when NORM = 'I'; otherwise, WORK is not
-*          referenced.
+*     .. Scalar Arguments ..
+      CHARACTER          DIAG, NORM, UPLO
+      INTEGER            LDA, M, N
+*     ..
+*     .. Array Arguments ..
+      DOUBLE PRECISION   WORK( * )
+      COMPLEX*16         A( LDA, * )
+*     ..
 *
 * =====================================================================
 *