Integrating Doxygen in comments

1 files changed, 119 insertions, 52 deletions

diff --git a/SRC/zla_herpvgrw.f b/SRC/zla_herpvgrw.f
index d7abc1ce..63fae726 100644
--- a/SRC/zla_herpvgrw.f
+++ b/SRC/zla_herpvgrw.f
@@ -1,72 +1,139 @@
-      DOUBLE PRECISION FUNCTION ZLA_HERPVGRW( UPLO, N, INFO, A, LDA, AF,
-     $                                        LDAF, IPIV, WORK )
+*> \brief \b ZLA_HERPVGRW
 *
-*     -- LAPACK routine (version 3.2.2)                                 --
-*     -- Contributed by James Demmel, Deaglan Halligan, Yozo Hida and --
-*     -- Jason Riedy of Univ. of California Berkeley.                 --
-*     -- June 2010                                                    --
+*  =========== 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*1        UPLO
-      INTEGER            N, INFO, LDA, LDAF
-*     ..
-*     .. Array Arguments ..
-      INTEGER            IPIV( * )
-      COMPLEX*16         A( LDA, * ), AF( LDAF, * )
-      DOUBLE PRECISION   WORK( * )
-*     ..
+*  Definition
+*  ==========
 *
+*       DOUBLE PRECISION FUNCTION ZLA_HERPVGRW( UPLO, N, INFO, A, LDA, AF,
+*                                               LDAF, IPIV, WORK )
+* 
+*       .. Scalar Arguments ..
+*       CHARACTER*1        UPLO
+*       INTEGER            N, INFO, LDA, LDAF
+*       ..
+*       .. Array Arguments ..
+*       INTEGER            IPIV( * )
+*       COMPLEX*16         A( LDA, * ), AF( LDAF, * )
+*       DOUBLE PRECISION   WORK( * )
+*       ..
+*  
 *  Purpose
 *  =======
-* 
-*  ZLA_HERPVGRW computes the reciprocal pivot growth factor
-*  norm(A)/norm(U). The "max absolute element" norm is used. If this is
-*  much less than 1, the stability of the LU factorization of the
-*  (equilibrated) matrix A could be poor. This also means that the
-*  solution X, estimated condition numbers, and error bounds could be
-*  unreliable.
+*
+*>\details \b Purpose:
+*>\verbatim
+*> 
+*> ZLA_HERPVGRW computes the reciprocal pivot growth factor
+*> norm(A)/norm(U). The "max absolute element" norm is used. If this is
+*> much less than 1, the stability of the LU factorization of the
+*> (equilibrated) matrix A could be poor. This also means that the
+*> solution X, estimated condition numbers, and error bounds could be
+*> unreliable.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*     UPLO    (input) CHARACTER*1
-*       = 'U':  Upper triangle of A is stored;
-*       = 'L':  Lower triangle of A is stored.
+*> \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] INFO
+*> \verbatim
+*>          INFO is INTEGER
+*>     The value of INFO returned from ZHETRF, .i.e., the pivot in
+*>     column INFO is exactly 0.
+*> \endverbatim
+*>
+*> \param[in] NCOLS
+*> \verbatim
+*>          NCOLS is INTEGER
+*>     The number of columns of the matrix A. NCOLS >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*>          A is COMPLEX*16 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 COMPLEX*16 array, dimension (LDAF,N)
+*>     The block diagonal matrix D and the multipliers used to
+*>     obtain the factor U or L as computed by ZHETRF.
+*> \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 ZHETRF.
+*> \endverbatim
+*>
+*> \param[in] WORK
+*> \verbatim
+*>          WORK is COMPLEX*16 array, dimension (2*N)
+*> \endverbatim
+*>
 *
-*     N       (input) INTEGER
-*     The number of linear equations, i.e., the order of the
-*     matrix A.  N >= 0.
-*
-*     INFO    (input) INTEGER
-*     The value of INFO returned from ZHETRF, .i.e., the pivot in
-*     column INFO is exactly 0.
-*
-*     NCOLS   (input) INTEGER
-*     The number of columns of the matrix A. NCOLS >= 0.
+*  Authors
+*  =======
 *
-*     A       (input) COMPLEX*16 array, dimension (LDA,N)
-*     On entry, the N-by-N matrix A.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*     LDA     (input) INTEGER
-*     The leading dimension of the array A.  LDA >= max(1,N).
+*> \date November 2011
 *
-*     AF      (input) COMPLEX*16 array, dimension (LDAF,N)
-*     The block diagonal matrix D and the multipliers used to
-*     obtain the factor U or L as computed by ZHETRF.
+*> \ingroup complex16HEcomputational
 *
-*     LDAF    (input) INTEGER
-*     The leading dimension of the array AF.  LDAF >= max(1,N).
+*  =====================================================================
+      DOUBLE PRECISION FUNCTION ZLA_HERPVGRW( UPLO, N, INFO, A, LDA, AF,
+     $                                        LDAF, IPIV, WORK )
 *
-*     IPIV    (input) INTEGER array, dimension (N)
-*     Details of the interchanges and the block structure of D
-*     as determined by ZHETRF.
+*  -- LAPACK computational routine (version 3.2.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    (input) COMPLEX*16 array, dimension (2*N)
+*     .. Scalar Arguments ..
+      CHARACTER*1        UPLO
+      INTEGER            N, INFO, LDA, LDAF
+*     ..
+*     .. Array Arguments ..
+      INTEGER            IPIV( * )
+      COMPLEX*16         A( LDA, * ), AF( LDAF, * )
+      DOUBLE PRECISION   WORK( * )
+*     ..
 *
 *  =====================================================================
 *