Integrating Doxygen in comments

1 files changed, 92 insertions, 40 deletions

diff --git a/TESTING/EIG/sget31.f b/TESTING/EIG/sget31.f
index 88628bc2..f2a166f7 100644
--- a/TESTING/EIG/sget31.f
+++ b/TESTING/EIG/sget31.f
@@ -1,58 +1,110 @@
-      SUBROUTINE SGET31( RMAX, LMAX, NINFO, KNT )
+*> \brief \b SGET31
 *
-*  -- LAPACK test routine (version 3.1) --
-*     Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd..
-*     November 2006
+*  =========== DOCUMENTATION ===========
 *
-*     .. Scalar Arguments ..
-      INTEGER            KNT, LMAX
-      REAL               RMAX
-*     ..
-*     .. Array Arguments ..
-      INTEGER            NINFO( 2 )
-*     ..
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
 *
+*       SUBROUTINE SGET31( RMAX, LMAX, NINFO, KNT )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            KNT, LMAX
+*       REAL               RMAX
+*       ..
+*       .. Array Arguments ..
+*       INTEGER            NINFO( 2 )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  SGET31 tests SLALN2, a routine for solving
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> SGET31 tests SLALN2, a routine for solving
+*>
+*>    (ca A - w D)X = sB
+*>
+*> where A is an NA by NA matrix (NA=1 or 2 only), w is a real (NW=1) or
+*> complex (NW=2) constant, ca is a real constant, D is an NA by NA real
+*> diagonal matrix, and B is an NA by NW matrix (when NW=2 the second
+*> column of B contains the imaginary part of the solution).  The code
+*> returns X and s, where s is a scale factor, less than or equal to 1,
+*> which is chosen to avoid overflow in X.
+*>
+*> If any singular values of ca A-w D are less than another input
+*> parameter SMIN, they are perturbed up to SMIN.
+*>
+*> The test condition is that the scaled residual
+*>
+*>     norm( (ca A-w D)*X - s*B ) /
+*>           ( max( ulp*norm(ca A-w D), SMIN )*norm(X) )
+*>
+*> should be on the order of 1.  Here, ulp is the machine precision.
+*> Also, it is verified that SCALE is less than or equal to 1, and that
+*> XNORM = infinity-norm(X).
+*>
+*>\endverbatim
 *
-*     (ca A - w D)X = sB
-*
-*  where A is an NA by NA matrix (NA=1 or 2 only), w is a real (NW=1) or
-*  complex (NW=2) constant, ca is a real constant, D is an NA by NA real
-*  diagonal matrix, and B is an NA by NW matrix (when NW=2 the second
-*  column of B contains the imaginary part of the solution).  The code
-*  returns X and s, where s is a scale factor, less than or equal to 1,
-*  which is chosen to avoid overflow in X.
-*
-*  If any singular values of ca A-w D are less than another input
-*  parameter SMIN, they are perturbed up to SMIN.
+*  Arguments
+*  =========
 *
-*  The test condition is that the scaled residual
+*> \param[out] RMAX
+*> \verbatim
+*>          RMAX is REAL
+*>          Value of the largest test ratio.
+*> \endverbatim
+*>
+*> \param[out] LMAX
+*> \verbatim
+*>          LMAX is INTEGER
+*>          Example number where largest test ratio achieved.
+*> \endverbatim
+*>
+*> \param[out] NINFO
+*> \verbatim
+*>          NINFO is INTEGER array, dimension (3)
+*>          NINFO(1) = number of examples with INFO less than 0
+*>          NINFO(2) = number of examples with INFO greater than 0
+*> \endverbatim
+*>
+*> \param[out] KNT
+*> \verbatim
+*>          KNT is INTEGER
+*>          Total number of examples tested.
+*> \endverbatim
+*>
 *
-*      norm( (ca A-w D)*X - s*B ) /
-*            ( max( ulp*norm(ca A-w D), SMIN )*norm(X) )
+*  Authors
+*  =======
 *
-*  should be on the order of 1.  Here, ulp is the machine precision.
-*  Also, it is verified that SCALE is less than or equal to 1, and that
-*  XNORM = infinity-norm(X).
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  Arguments
-*  ==========
+*> \date November 2011
 *
-*  RMAX    (output) REAL
-*          Value of the largest test ratio.
+*> \ingroup single_eig
 *
-*  LMAX    (output) INTEGER
-*          Example number where largest test ratio achieved.
+*  =====================================================================
+      SUBROUTINE SGET31( RMAX, LMAX, NINFO, KNT )
 *
-*  NINFO   (output) INTEGER array, dimension (3)
-*          NINFO(1) = number of examples with INFO less than 0
-*          NINFO(2) = number of examples with INFO greater than 0
+*  -- LAPACK test routine (version 3.1) --
+*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
+*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
+*     November 2011
 *
-*  KNT     (output) INTEGER
-*          Total number of examples tested.
+*     .. Scalar Arguments ..
+      INTEGER            KNT, LMAX
+      REAL               RMAX
+*     ..
+*     .. Array Arguments ..
+      INTEGER            NINFO( 2 )
+*     ..
 *
 *  =====================================================================
 *