Integrating Doxygen in comments

1 files changed, 95 insertions, 39 deletions

diff --git a/SRC/cla_porpvgrw.f b/SRC/cla_porpvgrw.f
index df60bddf..5f38c156 100644
--- a/SRC/cla_porpvgrw.f
+++ b/SRC/cla_porpvgrw.f
@@ -1,58 +1,114 @@
-      REAL FUNCTION CLA_PORPVGRW( UPLO, NCOLS, A, LDA, AF, LDAF, WORK )
+*> \brief \b CLA_PORPVGRW
 *
-*     -- 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            NCOLS, LDA, LDAF
-*     ..
-*     .. Array Arguments ..
-      COMPLEX            A( LDA, * ), AF( LDAF, * )
-      REAL               WORK( * )
-*     ..
+*  Definition
+*  ==========
 *
+*       REAL FUNCTION CLA_PORPVGRW( UPLO, NCOLS, A, LDA, AF, LDAF, WORK )
+* 
+*       .. Scalar Arguments ..
+*       CHARACTER*1        UPLO
+*       INTEGER            NCOLS, LDA, LDAF
+*       ..
+*       .. Array Arguments ..
+*       COMPLEX            A( LDA, * ), AF( LDAF, * )
+*       REAL               WORK( * )
+*       ..
+*  
 *  Purpose
 *  =======
-* 
-*  CLA_PORPVGRW 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
+*> 
+*> CLA_PORPVGRW 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] NCOLS
+*> \verbatim
+*>          NCOLS is INTEGER
+*>     The number of columns of the matrix A. NCOLS >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*>          A is COMPLEX 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 array, dimension (LDAF,N)
+*>     The triangular factor U or L from the Cholesky factorization
+*>     A = U**T*U or A = L*L**T, as computed by CPOTRF.
+*> \endverbatim
+*>
+*> \param[in] LDAF
+*> \verbatim
+*>          LDAF is INTEGER
+*>     The leading dimension of the array AF.  LDAF >= max(1,N).
+*> \endverbatim
+*>
+*> \param[in] WORK
+*> \verbatim
+*>          WORK is COMPLEX array, dimension (2*N)
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*     NCOLS   (input) INTEGER
-*     The number of columns of the matrix A. NCOLS >= 0.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*     A       (input) COMPLEX array, dimension (LDA,N)
-*     On entry, the N-by-N matrix A.
+*> \date November 2011
 *
-*     LDA     (input) INTEGER
-*     The leading dimension of the array A.  LDA >= max(1,N).
+*> \ingroup complexPOcomputational
 *
-*     AF      (input) COMPLEX array, dimension (LDAF,N)
-*     The triangular factor U or L from the Cholesky factorization
-*     A = U**T*U or A = L*L**T, as computed by CPOTRF.
+*  =====================================================================
+      REAL FUNCTION CLA_PORPVGRW( UPLO, NCOLS, A, LDA, AF, LDAF, WORK )
 *
-*     LDAF    (input) INTEGER
-*     The leading dimension of the array AF.  LDAF >= max(1,N).
+*  -- 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 array, dimension (2*N)
+*     .. Scalar Arguments ..
+      CHARACTER*1        UPLO
+      INTEGER            NCOLS, LDA, LDAF
+*     ..
+*     .. Array Arguments ..
+      COMPLEX            A( LDA, * ), AF( LDAF, * )
+      REAL               WORK( * )
+*     ..
 *
 *  =====================================================================
 *