Integrating Doxygen in comments

1 files changed, 115 insertions, 54 deletions

diff --git a/SRC/slaneg.f b/SRC/slaneg.f
index 441a6c9a..55036d2f 100644
--- a/SRC/slaneg.f
+++ b/SRC/slaneg.f
@@ -1,72 +1,133 @@
-      INTEGER FUNCTION SLANEG( N, D, LLD, SIGMA, PIVMIN, R )
-      IMPLICIT NONE
-*
-*  -- LAPACK auxiliary 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..--
-*     June 2010
-*
-*     .. Scalar Arguments ..
-      INTEGER            N, R
-      REAL               PIVMIN, SIGMA
-*     ..
-*     .. Array Arguments ..
-      REAL               D( * ), LLD( * )
-*     ..
-*
+*> \brief \b SLANEG
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       INTEGER FUNCTION SLANEG( N, D, LLD, SIGMA, PIVMIN, R )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            N, R
+*       REAL               PIVMIN, SIGMA
+*       ..
+*       .. Array Arguments ..
+*       REAL               D( * ), LLD( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  SLANEG computes the Sturm count, the number of negative pivots
-*  encountered while factoring tridiagonal T - sigma I = L D L^T.
-*  This implementation works directly on the factors without forming
-*  the tridiagonal matrix T.  The Sturm count is also the number of
-*  eigenvalues of T less than sigma.
-*
-*  This routine is called from SLARRB.
-*
-*  The current routine does not use the PIVMIN parameter but rather
-*  requires IEEE-754 propagation of Infinities and NaNs.  This
-*  routine also has no input range restrictions but does require
-*  default exception handling such that x/0 produces Inf when x is
-*  non-zero, and Inf/Inf produces NaN.  For more information, see:
-*
-*    Marques, Riedy, and Voemel, "Benefits of IEEE-754 Features in
-*    Modern Symmetric Tridiagonal Eigensolvers," SIAM Journal on
-*    Scientific Computing, v28, n5, 2006.  DOI 10.1137/050641624
-*    (Tech report version in LAWN 172 with the same title.)
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> SLANEG computes the Sturm count, the number of negative pivots
+*> encountered while factoring tridiagonal T - sigma I = L D L^T.
+*> This implementation works directly on the factors without forming
+*> the tridiagonal matrix T.  The Sturm count is also the number of
+*> eigenvalues of T less than sigma.
+*>
+*> This routine is called from SLARRB.
+*>
+*> The current routine does not use the PIVMIN parameter but rather
+*> requires IEEE-754 propagation of Infinities and NaNs.  This
+*> routine also has no input range restrictions but does require
+*> default exception handling such that x/0 produces Inf when x is
+*> non-zero, and Inf/Inf produces NaN.  For more information, see:
+*>
+*>   Marques, Riedy, and Voemel, "Benefits of IEEE-754 Features in
+*>   Modern Symmetric Tridiagonal Eigensolvers," SIAM Journal on
+*>   Scientific Computing, v28, n5, 2006.  DOI 10.1137/050641624
+*>   (Tech report version in LAWN 172 with the same title.)
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  N       (input) INTEGER
-*          The order of the matrix.
-*
-*  D       (input) REAL array, dimension (N)
-*          The N diagonal elements of the diagonal matrix D.
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The order of the matrix.
+*> \endverbatim
+*>
+*> \param[in] D
+*> \verbatim
+*>          D is REAL array, dimension (N)
+*>          The N diagonal elements of the diagonal matrix D.
+*> \endverbatim
+*>
+*> \param[in] LLD
+*> \verbatim
+*>          LLD is REAL array, dimension (N-1)
+*>          The (N-1) elements L(i)*L(i)*D(i).
+*> \endverbatim
+*>
+*> \param[in] SIGMA
+*> \verbatim
+*>          SIGMA is REAL
+*>          Shift amount in T - sigma I = L D L^T.
+*> \endverbatim
+*>
+*> \param[in] PIVMIN
+*> \verbatim
+*>          PIVMIN is REAL
+*>          The minimum pivot in the Sturm sequence.  May be used
+*>          when zero pivots are encountered on non-IEEE-754
+*>          architectures.
+*> \endverbatim
+*>
+*> \param[in] R
+*> \verbatim
+*>          R is INTEGER
+*>          The twist index for the twisted factorization that is used
+*>          for the negcount.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  LLD     (input) REAL array, dimension (N-1)
-*          The (N-1) elements L(i)*L(i)*D(i).
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  SIGMA   (input) REAL            
-*          Shift amount in T - sigma I = L D L^T.
+*> \date November 2011
 *
-*  PIVMIN  (input) REAL            
-*          The minimum pivot in the Sturm sequence.  May be used
-*          when zero pivots are encountered on non-IEEE-754
-*          architectures.
+*> \ingroup auxOTHERauxiliary
 *
-*  R       (input) INTEGER
-*          The twist index for the twisted factorization that is used
-*          for the negcount.
 *
 *  Further Details
 *  ===============
+*>\details \b Further \b Details
+*> \verbatim
+*>
+*>  Based on contributions by
+*>     Osni Marques, LBNL/NERSC, USA
+*>     Christof Voemel, University of California, Berkeley, USA
+*>     Jason Riedy, University of California, Berkeley, USA
+*>
+*> \endverbatim
+*>
+*  =====================================================================
+      INTEGER FUNCTION SLANEG( N, D, LLD, SIGMA, PIVMIN, R )
+*
+*  -- LAPACK auxiliary 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
 *
-*  Based on contributions by
-*     Osni Marques, LBNL/NERSC, USA
-*     Christof Voemel, University of California, Berkeley, USA
-*     Jason Riedy, University of California, Berkeley, USA
+*     .. Scalar Arguments ..
+      INTEGER            N, R
+      REAL               PIVMIN, SIGMA
+*     ..
+*     .. Array Arguments ..
+      REAL               D( * ), LLD( * )
+*     ..
 *
 *  =====================================================================
 *