Integrating Doxygen in comments

1 files changed, 109 insertions, 51 deletions

diff --git a/SRC/sla_gbrpvgrw.f b/SRC/sla_gbrpvgrw.f
index 10cfe47f..85c7f224 100644
--- a/SRC/sla_gbrpvgrw.f
+++ b/SRC/sla_gbrpvgrw.f
@@ -1,67 +1,125 @@
-      REAL FUNCTION SLA_GBRPVGRW( N, KL, KU, NCOLS, AB, LDAB, AFB,
-     $                            LDAFB )
-*
-*     -- LAPACK routine (version 3.2.2)                                 --
-*     -- Contributed by James Demmel, Deaglan Halligan, Yozo Hida and --
-*     -- Jason Riedy of Univ. of California Berkeley.                 --
-*     -- June 2010                                                    --
-*
-*     -- LAPACK is a software package provided by Univ. of Tennessee, --
-*     -- Univ. of California Berkeley and NAG Ltd.                    --
-*
-      IMPLICIT NONE
-*     ..
-*     .. Scalar Arguments ..
-      INTEGER            N, KL, KU, NCOLS, LDAB, LDAFB
-*     ..
-*     .. Array Arguments ..
-      REAL               AB( LDAB, * ), AFB( LDAFB, * )
-*     ..
-*
+*> \brief \b SLA_GBRPVGRW
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       REAL FUNCTION SLA_GBRPVGRW( N, KL, KU, NCOLS, AB, LDAB, AFB,
+*                                   LDAFB )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            N, KL, KU, NCOLS, LDAB, LDAFB
+*       ..
+*       .. Array Arguments ..
+*       REAL               AB( LDAB, * ), AFB( LDAFB, * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  SLA_GBRPVGRW 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_GBRPVGRW 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.
-*
-*     KL      (input) INTEGER
-*     The number of subdiagonals within the band of A.  KL >= 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] KL
+*> \verbatim
+*>          KL is INTEGER
+*>     The number of subdiagonals within the band of A.  KL >= 0.
+*> \endverbatim
+*>
+*> \param[in] KU
+*> \verbatim
+*>          KU is INTEGER
+*>     The number of superdiagonals within the band of A.  KU >= 0.
+*> \endverbatim
+*>
+*> \param[in] NCOLS
+*> \verbatim
+*>          NCOLS is INTEGER
+*>     The number of columns of the matrix A.  NCOLS >= 0.
+*> \endverbatim
+*>
+*> \param[in] AB
+*> \verbatim
+*>          AB is REAL array, dimension (LDAB,N)
+*>     On entry, the matrix A in band storage, in rows 1 to KL+KU+1.
+*>     The j-th column of A is stored in the j-th column of the
+*>     array AB as follows:
+*>     AB(KU+1+i-j,j) = A(i,j) for max(1,j-KU)<=i<=min(N,j+kl)
+*> \endverbatim
+*>
+*> \param[in] LDAB
+*> \verbatim
+*>          LDAB is INTEGER
+*>     The leading dimension of the array AB.  LDAB >= KL+KU+1.
+*> \endverbatim
+*>
+*> \param[in] AFB
+*> \verbatim
+*>          AFB is REAL array, dimension (LDAFB,N)
+*>     Details of the LU factorization of the band matrix A, as
+*>     computed by SGBTRF.  U is stored as an upper triangular
+*>     band matrix with KL+KU superdiagonals in rows 1 to KL+KU+1,
+*>     and the multipliers used during the factorization are stored
+*>     in rows KL+KU+2 to 2*KL+KU+1.
+*> \endverbatim
+*>
+*> \param[in] LDAFB
+*> \verbatim
+*>          LDAFB is INTEGER
+*>     The leading dimension of the array AFB.  LDAFB >= 2*KL+KU+1.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*     KU      (input) INTEGER
-*     The number of superdiagonals within the band of A.  KU >= 0.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*     NCOLS   (input) INTEGER
-*     The number of columns of the matrix A.  NCOLS >= 0.
+*> \date November 2011
 *
-*     AB      (input) REAL array, dimension (LDAB,N)
-*     On entry, the matrix A in band storage, in rows 1 to KL+KU+1.
-*     The j-th column of A is stored in the j-th column of the
-*     array AB as follows:
-*     AB(KU+1+i-j,j) = A(i,j) for max(1,j-KU)<=i<=min(N,j+kl)
+*> \ingroup realGBcomputational
 *
-*     LDAB    (input) INTEGER
-*     The leading dimension of the array AB.  LDAB >= KL+KU+1.
+*  =====================================================================
+      REAL FUNCTION SLA_GBRPVGRW( N, KL, KU, NCOLS, AB, LDAB, AFB,
+     $                            LDAFB )
 *
-*     AFB     (input) REAL array, dimension (LDAFB,N)
-*     Details of the LU factorization of the band matrix A, as
-*     computed by SGBTRF.  U is stored as an upper triangular
-*     band matrix with KL+KU superdiagonals in rows 1 to KL+KU+1,
-*     and the multipliers used during the factorization are stored
-*     in rows KL+KU+2 to 2*KL+KU+1.
+*  -- 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
 *
-*     LDAFB   (input) INTEGER
-*     The leading dimension of the array AFB.  LDAFB >= 2*KL+KU+1.
+*     .. Scalar Arguments ..
+      INTEGER            N, KL, KU, NCOLS, LDAB, LDAFB
+*     ..
+*     .. Array Arguments ..
+      REAL               AB( LDAB, * ), AFB( LDAFB, * )
+*     ..
 *
 *  =====================================================================
 *