Integrating Doxygen in comments

1 files changed, 136 insertions, 61 deletions

diff --git a/SRC/claqge.f b/SRC/claqge.f
index 7309d6e6..04ad25f1 100644
--- a/SRC/claqge.f
+++ b/SRC/claqge.f
@@ -1,10 +1,145 @@
+*> \brief \b CLAQGE
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE CLAQGE( M, N, A, LDA, R, C, ROWCND, COLCND, AMAX,
+*                          EQUED )
+* 
+*       .. Scalar Arguments ..
+*       CHARACTER          EQUED
+*       INTEGER            LDA, M, N
+*       REAL               AMAX, COLCND, ROWCND
+*       ..
+*       .. Array Arguments ..
+*       REAL               C( * ), R( * )
+*       COMPLEX            A( LDA, * )
+*       ..
+*  
+*  Purpose
+*  =======
+*
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> CLAQGE equilibrates a general M by N matrix A using the row and
+*> column scaling factors in the vectors R and C.
+*>
+*>\endverbatim
+*
+*  Arguments
+*  =========
+*
+*> \param[in] M
+*> \verbatim
+*>          M is INTEGER
+*>          The number of rows of the matrix A.  M >= 0.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The number of columns of the matrix A.  N >= 0.
+*> \endverbatim
+*>
+*> \param[in,out] A
+*> \verbatim
+*>          A is COMPLEX array, dimension (LDA,N)
+*>          On entry, the M by N matrix A.
+*>          On exit, the equilibrated matrix.  See EQUED for the form of
+*>          the equilibrated matrix.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER
+*>          The leading dimension of the array A.  LDA >= max(M,1).
+*> \endverbatim
+*>
+*> \param[in] R
+*> \verbatim
+*>          R is REAL array, dimension (M)
+*>          The row scale factors for A.
+*> \endverbatim
+*>
+*> \param[in] C
+*> \verbatim
+*>          C is REAL array, dimension (N)
+*>          The column scale factors for A.
+*> \endverbatim
+*>
+*> \param[in] ROWCND
+*> \verbatim
+*>          ROWCND is REAL
+*>          Ratio of the smallest R(i) to the largest R(i).
+*> \endverbatim
+*>
+*> \param[in] COLCND
+*> \verbatim
+*>          COLCND is REAL
+*>          Ratio of the smallest C(i) to the largest C(i).
+*> \endverbatim
+*>
+*> \param[in] AMAX
+*> \verbatim
+*>          AMAX is REAL
+*>          Absolute value of largest matrix entry.
+*> \endverbatim
+*>
+*> \param[out] EQUED
+*> \verbatim
+*>          EQUED is CHARACTER*1
+*>          Specifies the form of equilibration that was done.
+*>          = 'N':  No equilibration
+*>          = 'R':  Row equilibration, i.e., A has been premultiplied by
+*>                  diag(R).
+*>          = 'C':  Column equilibration, i.e., A has been postmultiplied
+*>                  by diag(C).
+*>          = 'B':  Both row and column equilibration, i.e., A has been
+*>                  replaced by diag(R) * A * diag(C).
+*> \endverbatim
+*> \verbatim
+*>  Internal Parameters
+*>  ===================
+*> \endverbatim
+*> \verbatim
+*>  THRESH is a threshold value used to decide if row or column scaling
+*>  should be done based on the ratio of the row or column scaling
+*>  factors.  If ROWCND < THRESH, row scaling is done, and if
+*>  COLCND < THRESH, column scaling is done.
+*> \endverbatim
+*> \verbatim
+*>  LARGE and SMALL are threshold values used to decide if row scaling
+*>  should be done based on the absolute size of the largest matrix
+*>  element.  If AMAX > LARGE or AMAX < SMALL, row scaling is done.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
+*
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
+*
+*> \date November 2011
+*
+*> \ingroup complexGEauxiliary
+*
+*  =====================================================================
       SUBROUTINE CLAQGE( M, N, A, LDA, R, C, ROWCND, COLCND, AMAX,
      $                   EQUED )
 *
 *  -- LAPACK auxiliary routine (version 3.2) --
 *  -- LAPACK is a software package provided by Univ. of Tennessee,    --
 *  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
-*     November 2006
+*     November 2011
 *
 *     .. Scalar Arguments ..
       CHARACTER          EQUED
@@ -16,66 +151,6 @@
       COMPLEX            A( LDA, * )
 *     ..
 *
-*  Purpose
-*  =======
-*
-*  CLAQGE equilibrates a general M by N matrix A using the row and
-*  column scaling factors in the vectors R and C.
-*
-*  Arguments
-*  =========
-*
-*  M       (input) INTEGER
-*          The number of rows of the matrix A.  M >= 0.
-*
-*  N       (input) INTEGER
-*          The number of columns of the matrix A.  N >= 0.
-*
-*  A       (input/output) COMPLEX array, dimension (LDA,N)
-*          On entry, the M by N matrix A.
-*          On exit, the equilibrated matrix.  See EQUED for the form of
-*          the equilibrated matrix.
-*
-*  LDA     (input) INTEGER
-*          The leading dimension of the array A.  LDA >= max(M,1).
-*
-*  R       (input) REAL array, dimension (M)
-*          The row scale factors for A.
-*
-*  C       (input) REAL array, dimension (N)
-*          The column scale factors for A.
-*
-*  ROWCND  (input) REAL
-*          Ratio of the smallest R(i) to the largest R(i).
-*
-*  COLCND  (input) REAL
-*          Ratio of the smallest C(i) to the largest C(i).
-*
-*  AMAX    (input) REAL
-*          Absolute value of largest matrix entry.
-*
-*  EQUED   (output) CHARACTER*1
-*          Specifies the form of equilibration that was done.
-*          = 'N':  No equilibration
-*          = 'R':  Row equilibration, i.e., A has been premultiplied by
-*                  diag(R).
-*          = 'C':  Column equilibration, i.e., A has been postmultiplied
-*                  by diag(C).
-*          = 'B':  Both row and column equilibration, i.e., A has been
-*                  replaced by diag(R) * A * diag(C).
-*
-*  Internal Parameters
-*  ===================
-*
-*  THRESH is a threshold value used to decide if row or column scaling
-*  should be done based on the ratio of the row or column scaling
-*  factors.  If ROWCND < THRESH, row scaling is done, and if
-*  COLCND < THRESH, column scaling is done.
-*
-*  LARGE and SMALL are threshold values used to decide if row scaling
-*  should be done based on the absolute size of the largest matrix
-*  element.  If AMAX > LARGE or AMAX < SMALL, row scaling is done.
-*
 *  =====================================================================
 *
 *     .. Parameters ..