Integrating Doxygen in comments

1 files changed, 140 insertions, 67 deletions

diff --git a/SRC/dla_syrcond.f b/SRC/dla_syrcond.f
index fd39a3c5..1055f41d 100644
--- a/SRC/dla_syrcond.f
+++ b/SRC/dla_syrcond.f
@@ -1,85 +1,158 @@
-      DOUBLE PRECISION FUNCTION DLA_SYRCOND( UPLO, N, A, LDA, AF, LDAF, 
-     $                                       IPIV, CMODE, C, INFO, WORK,
-     $                                       IWORK )
+*> \brief \b DLA_SYRCOND
 *
-*     -- LAPACK routine (version 3.2.1)                                 --
-*     -- Contributed by James Demmel, Deaglan Halligan, Yozo Hida and --
-*     -- Jason Riedy of Univ. of California Berkeley.                 --
-*     -- April 2009                                                   --
+*  =========== DOCUMENTATION ===========
 *
-*     -- LAPACK is a software package provided by Univ. of Tennessee, --
-*     -- Univ. of California Berkeley and NAG Ltd.                    --
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
 *
-      IMPLICIT NONE
-*     ..
-*     .. Scalar Arguments ..
-      CHARACTER          UPLO
-      INTEGER            N, LDA, LDAF, INFO, CMODE
-*     ..
-*     .. Array Arguments
-      INTEGER            IWORK( * ), IPIV( * )
-      DOUBLE PRECISION   A( LDA, * ), AF( LDAF, * ), WORK( * ), C( * )
-*     ..
+*  Definition
+*  ==========
 *
+*       DOUBLE PRECISION FUNCTION DLA_SYRCOND( UPLO, N, A, LDA, AF, LDAF, 
+*                                              IPIV, CMODE, C, INFO, WORK,
+*                                              IWORK )
+* 
+*       .. Scalar Arguments ..
+*       CHARACTER          UPLO
+*       INTEGER            N, LDA, LDAF, INFO, CMODE
+*       ..
+*       .. Array Arguments
+*       INTEGER            IWORK( * ), IPIV( * )
+*       DOUBLE PRECISION   A( LDA, * ), AF( LDAF, * ), WORK( * ), C( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*     DLA_SYRCOND estimates the Skeel condition number of  op(A) * op2(C)
-*     where op2 is determined by CMODE as follows
-*     CMODE =  1    op2(C) = C
-*     CMODE =  0    op2(C) = I
-*     CMODE = -1    op2(C) = inv(C)
-*     The Skeel condition number cond(A) = norminf( |inv(A)||A| )
-*     is computed by computing scaling factors R such that
-*     diag(R)*A*op2(C) is row equilibrated and computing the standard
-*     infinity-norm condition number.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*>    DLA_SYRCOND estimates the Skeel condition number of  op(A) * op2(C)
+*>    where op2 is determined by CMODE as follows
+*>    CMODE =  1    op2(C) = C
+*>    CMODE =  0    op2(C) = I
+*>    CMODE = -1    op2(C) = inv(C)
+*>    The Skeel condition number cond(A) = norminf( |inv(A)||A| )
+*>    is computed by computing scaling factors R such that
+*>    diag(R)*A*op2(C) is row equilibrated and computing the standard
+*>    infinity-norm condition number.
+*>
+*>\endverbatim
 *
 *  Arguments
-*  ==========
-*
-*     UPLO    (input) CHARACTER*1
-*       = 'U':  Upper triangle of A is stored;
-*       = 'L':  Lower triangle of A is stored.
-*
-*     N       (input) INTEGER
-*     The number of linear equations, i.e., the order of the
-*     matrix A.  N >= 0.
-*
-*     A       (input) DOUBLE PRECISION array, dimension (LDA,N)
-*     On entry, the N-by-N matrix A.
-*
-*     LDA     (input) INTEGER
-*     The leading dimension of the array A.  LDA >= max(1,N).
-*
-*     AF      (input) DOUBLE PRECISION array, dimension (LDAF,N)
-*     The block diagonal matrix D and the multipliers used to
-*     obtain the factor U or L as computed by DSYTRF.
-*
-*     LDAF    (input) INTEGER
-*     The leading dimension of the array AF.  LDAF >= max(1,N).
+*  =========
+*
+*> \param[in] UPLO
+*> \verbatim
+*>          UPLO is CHARACTER*1
+*>       = 'U':  Upper triangle of A is stored;
+*>       = 'L':  Lower triangle of A is stored.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>     The number of linear equations, i.e., the order of the
+*>     matrix A.  N >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*>          A is DOUBLE PRECISION array, dimension (LDA,N)
+*>     On entry, the N-by-N matrix A.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER
+*>     The leading dimension of the array A.  LDA >= max(1,N).
+*> \endverbatim
+*>
+*> \param[in] AF
+*> \verbatim
+*>          AF is DOUBLE PRECISION array, dimension (LDAF,N)
+*>     The block diagonal matrix D and the multipliers used to
+*>     obtain the factor U or L as computed by DSYTRF.
+*> \endverbatim
+*>
+*> \param[in] LDAF
+*> \verbatim
+*>          LDAF is INTEGER
+*>     The leading dimension of the array AF.  LDAF >= max(1,N).
+*> \endverbatim
+*>
+*> \param[in] IPIV
+*> \verbatim
+*>          IPIV is INTEGER array, dimension (N)
+*>     Details of the interchanges and the block structure of D
+*>     as determined by DSYTRF.
+*> \endverbatim
+*>
+*> \param[in] CMODE
+*> \verbatim
+*>          CMODE is INTEGER
+*>     Determines op2(C) in the formula op(A) * op2(C) as follows:
+*>     CMODE =  1    op2(C) = C
+*>     CMODE =  0    op2(C) = I
+*>     CMODE = -1    op2(C) = inv(C)
+*> \endverbatim
+*>
+*> \param[in] C
+*> \verbatim
+*>          C is DOUBLE PRECISION array, dimension (N)
+*>     The vector C in the formula op(A) * op2(C).
+*> \endverbatim
+*>
+*> \param[out] INFO
+*> \verbatim
+*>          INFO is INTEGER
+*>       = 0:  Successful exit.
+*>     i > 0:  The ith argument is invalid.
+*> \endverbatim
+*>
+*> \param[in] WORK
+*> \verbatim
+*>          WORK is DOUBLE PRECISION array, dimension (3*N).
+*>     Workspace.
+*> \endverbatim
+*>
+*> \param[in] IWORK
+*> \verbatim
+*>          IWORK is INTEGER array, dimension (N).
+*>     Workspace.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*     IPIV    (input) INTEGER array, dimension (N)
-*     Details of the interchanges and the block structure of D
-*     as determined by DSYTRF.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*     CMODE   (input) INTEGER
-*     Determines op2(C) in the formula op(A) * op2(C) as follows:
-*     CMODE =  1    op2(C) = C
-*     CMODE =  0    op2(C) = I
-*     CMODE = -1    op2(C) = inv(C)
+*> \date November 2011
 *
-*     C       (input) DOUBLE PRECISION array, dimension (N)
-*     The vector C in the formula op(A) * op2(C).
+*> \ingroup doubleSYcomputational
 *
-*     INFO    (output) INTEGER
-*       = 0:  Successful exit.
-*     i > 0:  The ith argument is invalid.
+*  =====================================================================
+      DOUBLE PRECISION FUNCTION DLA_SYRCOND( UPLO, N, A, LDA, AF, LDAF, 
+     $                                       IPIV, CMODE, C, INFO, WORK,
+     $                                       IWORK )
 *
-*     WORK    (input) DOUBLE PRECISION array, dimension (3*N).
-*     Workspace.
+*  -- LAPACK computational routine (version 3.2.1) --
+*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
+*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
+*     November 2011
 *
-*     IWORK   (input) INTEGER array, dimension (N).
-*     Workspace.
+*     .. Scalar Arguments ..
+      CHARACTER          UPLO
+      INTEGER            N, LDA, LDAF, INFO, CMODE
+*     ..
+*     .. Array Arguments
+      INTEGER            IWORK( * ), IPIV( * )
+      DOUBLE PRECISION   A( LDA, * ), AF( LDAF, * ), WORK( * ), C( * )
+*     ..
 *
 *  =====================================================================
 *