Integrating Doxygen in comments

1 files changed, 86 insertions, 35 deletions

diff --git a/SRC/sla_gerpvgrw.f b/SRC/sla_gerpvgrw.f
index 3547caac..6d2b086d 100644
--- a/SRC/sla_gerpvgrw.f
+++ b/SRC/sla_gerpvgrw.f
@@ -1,54 +1,105 @@
-      REAL FUNCTION SLA_GERPVGRW( N, NCOLS, A, LDA, AF, LDAF )
+*> \brief \b SLA_GERPVGRW
 *
-*     -- 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 ..
-      INTEGER            N, NCOLS, LDA, LDAF
-*     ..
-*     .. Array Arguments ..
-      REAL               A( LDA, * ), AF( LDAF, * )
-*     ..
+*  Definition
+*  ==========
 *
+*       REAL FUNCTION SLA_GERPVGRW( N, NCOLS, A, LDA, AF, LDAF )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            N, NCOLS, LDA, LDAF
+*       ..
+*       .. Array Arguments ..
+*       REAL               A( LDA, * ), AF( LDAF, * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  SLA_GERPVGRW 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
+*>
+*> SLA_GERPVGRW 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
 *  =========
 *
-*     N       (input) INTEGER
-*     The number of linear equations, i.e., the order of the
-*     matrix A.  N >= 0.
+*> \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] NCOLS
+*> \verbatim
+*>          NCOLS is INTEGER
+*>     The number of columns of the matrix A. NCOLS >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*>          A is REAL 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 REAL array, dimension (LDAF,N)
+*>     The factors L and U from the factorization
+*>     A = P*L*U as computed by SGETRF.
+*> \endverbatim
+*>
+*> \param[in] LDAF
+*> \verbatim
+*>          LDAF is INTEGER
+*>     The leading dimension of the array AF.  LDAF >= max(1,N).
+*> \endverbatim
+*>
 *
-*     NCOLS   (input) INTEGER
-*     The number of columns of the matrix A. NCOLS >= 0.
+*  Authors
+*  =======
 *
-*     A       (input) REAL 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) REAL array, dimension (LDAF,N)
-*     The factors L and U from the factorization
-*     A = P*L*U as computed by SGETRF.
+*> \ingroup realGEcomputational
 *
-*     LDAF    (input) INTEGER
-*     The leading dimension of the array AF.  LDAF >= max(1,N).
+*  =====================================================================
+      REAL FUNCTION SLA_GERPVGRW( N, NCOLS, A, LDA, AF, LDAF )
+*
+*  -- 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
+*
+*     .. Scalar Arguments ..
+      INTEGER            N, NCOLS, LDA, LDAF
+*     ..
+*     .. Array Arguments ..
+      REAL               A( LDA, * ), AF( LDAF, * )
+*     ..
 *
 *  =====================================================================
 *