Integrating Doxygen in comments

1 files changed, 121 insertions, 52 deletions

diff --git a/SRC/sgtts2.f b/SRC/sgtts2.f
index 293d3f04..344ef335 100644
--- a/SRC/sgtts2.f
+++ b/SRC/sgtts2.f
@@ -1,68 +1,137 @@
-      SUBROUTINE SGTTS2( ITRANS, N, NRHS, DL, D, DU, DU2, IPIV, B, LDB )
-*
-*  -- 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
-*
-*     .. Scalar Arguments ..
-      INTEGER            ITRANS, LDB, N, NRHS
-*     ..
-*     .. Array Arguments ..
-      INTEGER            IPIV( * )
-      REAL               B( LDB, * ), D( * ), DL( * ), DU( * ), DU2( * )
-*     ..
-*
+*> \brief \b SGTTS2
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE SGTTS2( ITRANS, N, NRHS, DL, D, DU, DU2, IPIV, B, LDB )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            ITRANS, LDB, N, NRHS
+*       ..
+*       .. Array Arguments ..
+*       INTEGER            IPIV( * )
+*       REAL               B( LDB, * ), D( * ), DL( * ), DU( * ), DU2( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  SGTTS2 solves one of the systems of equations
-*     A*X = B  or  A**T*X = B,
-*  with a tridiagonal matrix A using the LU factorization computed
-*  by SGTTRF.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> SGTTS2 solves one of the systems of equations
+*>    A*X = B  or  A**T*X = B,
+*> with a tridiagonal matrix A using the LU factorization computed
+*> by SGTTRF.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  ITRANS  (input) INTEGER
-*          Specifies the form of the system of equations.
-*          = 0:  A * X = B  (No transpose)
-*          = 1:  A**T* X = B  (Transpose)
-*          = 2:  A**T* X = B  (Conjugate transpose = Transpose)
-*
-*  N       (input) INTEGER
-*          The order of the matrix A.
-*
-*  NRHS    (input) INTEGER
-*          The number of right hand sides, i.e., the number of columns
-*          of the matrix B.  NRHS >= 0.
-*
-*  DL      (input) REAL array, dimension (N-1)
-*          The (n-1) multipliers that define the matrix L from the
-*          LU factorization of A.
+*> \param[in] ITRANS
+*> \verbatim
+*>          ITRANS is INTEGER
+*>          Specifies the form of the system of equations.
+*>          = 0:  A * X = B  (No transpose)
+*>          = 1:  A**T* X = B  (Transpose)
+*>          = 2:  A**T* X = B  (Conjugate transpose = Transpose)
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The order of the matrix A.
+*> \endverbatim
+*>
+*> \param[in] NRHS
+*> \verbatim
+*>          NRHS is INTEGER
+*>          The number of right hand sides, i.e., the number of columns
+*>          of the matrix B.  NRHS >= 0.
+*> \endverbatim
+*>
+*> \param[in] DL
+*> \verbatim
+*>          DL is REAL array, dimension (N-1)
+*>          The (n-1) multipliers that define the matrix L from the
+*>          LU factorization of A.
+*> \endverbatim
+*>
+*> \param[in] D
+*> \verbatim
+*>          D is REAL array, dimension (N)
+*>          The n diagonal elements of the upper triangular matrix U from
+*>          the LU factorization of A.
+*> \endverbatim
+*>
+*> \param[in] DU
+*> \verbatim
+*>          DU is REAL array, dimension (N-1)
+*>          The (n-1) elements of the first super-diagonal of U.
+*> \endverbatim
+*>
+*> \param[in] DU2
+*> \verbatim
+*>          DU2 is REAL array, dimension (N-2)
+*>          The (n-2) elements of the second super-diagonal of U.
+*> \endverbatim
+*>
+*> \param[in] IPIV
+*> \verbatim
+*>          IPIV is INTEGER array, dimension (N)
+*>          The pivot indices; for 1 <= i <= n, row i of the matrix was
+*>          interchanged with row IPIV(i).  IPIV(i) will always be either
+*>          i or i+1; IPIV(i) = i indicates a row interchange was not
+*>          required.
+*> \endverbatim
+*>
+*> \param[in,out] B
+*> \verbatim
+*>          B is REAL array, dimension (LDB,NRHS)
+*>          On entry, the matrix of right hand side vectors B.
+*>          On exit, B is overwritten by the solution vectors X.
+*> \endverbatim
+*>
+*> \param[in] LDB
+*> \verbatim
+*>          LDB is INTEGER
+*>          The leading dimension of the array B.  LDB >= max(1,N).
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  D       (input) REAL array, dimension (N)
-*          The n diagonal elements of the upper triangular matrix U from
-*          the LU factorization of A.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  DU      (input) REAL array, dimension (N-1)
-*          The (n-1) elements of the first super-diagonal of U.
+*> \date November 2011
 *
-*  DU2     (input) REAL array, dimension (N-2)
-*          The (n-2) elements of the second super-diagonal of U.
+*> \ingroup realOTHERauxiliary
 *
-*  IPIV    (input) INTEGER array, dimension (N)
-*          The pivot indices; for 1 <= i <= n, row i of the matrix was
-*          interchanged with row IPIV(i).  IPIV(i) will always be either
-*          i or i+1; IPIV(i) = i indicates a row interchange was not
-*          required.
+*  =====================================================================
+      SUBROUTINE SGTTS2( ITRANS, N, NRHS, DL, D, DU, DU2, IPIV, B, LDB )
 *
-*  B       (input/output) REAL array, dimension (LDB,NRHS)
-*          On entry, the matrix of right hand side vectors B.
-*          On exit, B is overwritten by the solution vectors X.
+*  -- 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 2011
 *
-*  LDB     (input) INTEGER
-*          The leading dimension of the array B.  LDB >= max(1,N).
+*     .. Scalar Arguments ..
+      INTEGER            ITRANS, LDB, N, NRHS
+*     ..
+*     .. Array Arguments ..
+      INTEGER            IPIV( * )
+      REAL               B( LDB, * ), D( * ), DL( * ), DU( * ), DU2( * )
+*     ..
 *
 *  =====================================================================
 *