Integrating Doxygen in comments

1 files changed, 98 insertions, 39 deletions

diff --git a/SRC/dpttrs.f b/SRC/dpttrs.f
index e581f5e0..c0339785 100644
--- a/SRC/dpttrs.f
+++ b/SRC/dpttrs.f
@@ -1,58 +1,117 @@
-      SUBROUTINE DPTTRS( N, NRHS, D, E, B, LDB, INFO )
+*> \brief \b DPTTRS
 *
-*  -- LAPACK routine (version 3.3.1) --
-*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
-*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
-*  -- April 2011                                                      --
+*  =========== DOCUMENTATION ===========
 *
-*     .. Scalar Arguments ..
-      INTEGER            INFO, LDB, N, NRHS
-*     ..
-*     .. Array Arguments ..
-      DOUBLE PRECISION   B( LDB, * ), D( * ), E( * )
-*     ..
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
 *
+*  Definition
+*  ==========
+*
+*       SUBROUTINE DPTTRS( N, NRHS, D, E, B, LDB, INFO )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            INFO, LDB, N, NRHS
+*       ..
+*       .. Array Arguments ..
+*       DOUBLE PRECISION   B( LDB, * ), D( * ), E( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  DPTTRS solves a tridiagonal system of the form
-*     A * X = B
-*  using the L*D*L**T factorization of A computed by DPTTRF.  D is a
-*  diagonal matrix specified in the vector D, L is a unit bidiagonal
-*  matrix whose subdiagonal is specified in the vector E, and X and B
-*  are N by NRHS matrices.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> DPTTRS solves a tridiagonal system of the form
+*>    A * X = B
+*> using the L*D*L**T factorization of A computed by DPTTRF.  D is a
+*> diagonal matrix specified in the vector D, L is a unit bidiagonal
+*> matrix whose subdiagonal is specified in the vector E, and X and B
+*> are N by NRHS matrices.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  N       (input) INTEGER
-*          The order of the tridiagonal matrix A.  N >= 0.
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The order of the tridiagonal matrix A.  N >= 0.
+*> \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] D
+*> \verbatim
+*>          D is DOUBLE PRECISION array, dimension (N)
+*>          The n diagonal elements of the diagonal matrix D from the
+*>          L*D*L**T factorization of A.
+*> \endverbatim
+*>
+*> \param[in] E
+*> \verbatim
+*>          E is DOUBLE PRECISION array, dimension (N-1)
+*>          The (n-1) subdiagonal elements of the unit bidiagonal factor
+*>          L from the L*D*L**T factorization of A.  E can also be regarded
+*>          as the superdiagonal of the unit bidiagonal factor U from the
+*>          factorization A = U**T*D*U.
+*> \endverbatim
+*>
+*> \param[in,out] B
+*> \verbatim
+*>          B is DOUBLE PRECISION array, dimension (LDB,NRHS)
+*>          On entry, the right hand side vectors B for the system of
+*>          linear equations.
+*>          On exit, the solution vectors, X.
+*> \endverbatim
+*>
+*> \param[in] LDB
+*> \verbatim
+*>          LDB is INTEGER
+*>          The leading dimension of the array B.  LDB >= max(1,N).
+*> \endverbatim
+*>
+*> \param[out] INFO
+*> \verbatim
+*>          INFO is INTEGER
+*>          = 0: successful exit
+*>          < 0: if INFO = -k, the k-th argument had an illegal value
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  NRHS    (input) INTEGER
-*          The number of right hand sides, i.e., the number of columns
-*          of the matrix B.  NRHS >= 0.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  D       (input) DOUBLE PRECISION array, dimension (N)
-*          The n diagonal elements of the diagonal matrix D from the
-*          L*D*L**T factorization of A.
+*> \date November 2011
 *
-*  E       (input) DOUBLE PRECISION array, dimension (N-1)
-*          The (n-1) subdiagonal elements of the unit bidiagonal factor
-*          L from the L*D*L**T factorization of A.  E can also be regarded
-*          as the superdiagonal of the unit bidiagonal factor U from the
-*          factorization A = U**T*D*U.
+*> \ingroup doubleOTHERcomputational
 *
-*  B       (input/output) DOUBLE PRECISION array, dimension (LDB,NRHS)
-*          On entry, the right hand side vectors B for the system of
-*          linear equations.
-*          On exit, the solution vectors, X.
+*  =====================================================================
+      SUBROUTINE DPTTRS( N, NRHS, D, E, B, LDB, INFO )
 *
-*  LDB     (input) INTEGER
-*          The leading dimension of the array B.  LDB >= max(1,N).
+*  -- LAPACK computational routine (version 3.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
 *
-*  INFO    (output) INTEGER
-*          = 0: successful exit
-*          < 0: if INFO = -k, the k-th argument had an illegal value
+*     .. Scalar Arguments ..
+      INTEGER            INFO, LDB, N, NRHS
+*     ..
+*     .. Array Arguments ..
+      DOUBLE PRECISION   B( LDB, * ), D( * ), E( * )
+*     ..
 *
 *  =====================================================================
 *