Integrating Doxygen in comments

1 files changed, 118 insertions, 56 deletions

diff --git a/SRC/zgtsv.f b/SRC/zgtsv.f
index a22338da..804f19ca 100644
--- a/SRC/zgtsv.f
+++ b/SRC/zgtsv.f
@@ -1,70 +1,132 @@
-      SUBROUTINE ZGTSV( N, NRHS, DL, D, DU, B, LDB, INFO )
+*> \brief \b ZGTSV
 *
-*  -- 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 ..
-      COMPLEX*16         B( LDB, * ), D( * ), DL( * ), DU( * )
-*     ..
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
 *
+*  Definition
+*  ==========
+*
+*       SUBROUTINE ZGTSV( N, NRHS, DL, D, DU, B, LDB, INFO )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            INFO, LDB, N, NRHS
+*       ..
+*       .. Array Arguments ..
+*       COMPLEX*16         B( LDB, * ), D( * ), DL( * ), DU( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  ZGTSV  solves the equation
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> ZGTSV  solves the equation
+*>
+*>    A*X = B,
+*>
+*> where A is an N-by-N tridiagonal matrix, by Gaussian elimination with
+*> partial pivoting.
+*>
+*> Note that the equation  A**T *X = B  may be solved by interchanging the
+*> order of the arguments DU and DL.
+*>
+*>\endverbatim
 *
-*     A*X = B,
+*  Arguments
+*  =========
 *
-*  where A is an N-by-N tridiagonal matrix, by Gaussian elimination with
-*  partial pivoting.
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The order of the 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,out] DL
+*> \verbatim
+*>          DL is COMPLEX*16 array, dimension (N-1)
+*>          On entry, DL must contain the (n-1) subdiagonal elements of
+*>          A.
+*>          On exit, DL is overwritten by the (n-2) elements of the
+*>          second superdiagonal of the upper triangular matrix U from
+*>          the LU factorization of A, in DL(1), ..., DL(n-2).
+*> \endverbatim
+*>
+*> \param[in,out] D
+*> \verbatim
+*>          D is COMPLEX*16 array, dimension (N)
+*>          On entry, D must contain the diagonal elements of A.
+*>          On exit, D is overwritten by the n diagonal elements of U.
+*> \endverbatim
+*>
+*> \param[in,out] DU
+*> \verbatim
+*>          DU is COMPLEX*16 array, dimension (N-1)
+*>          On entry, DU must contain the (n-1) superdiagonal elements
+*>          of A.
+*>          On exit, DU is overwritten by the (n-1) elements of the first
+*>          superdiagonal of U.
+*> \endverbatim
+*>
+*> \param[in,out] B
+*> \verbatim
+*>          B is COMPLEX*16 array, dimension (LDB,NRHS)
+*>          On entry, the N-by-NRHS right hand side matrix B.
+*>          On exit, if INFO = 0, the N-by-NRHS solution matrix 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 = -i, the i-th argument had an illegal value
+*>          > 0:  if INFO = i, U(i,i) is exactly zero, and the solution
+*>                has not been computed.  The factorization has not been
+*>                completed unless i = N.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  Note that the equation  A**T *X = B  may be solved by interchanging the
-*  order of the arguments DU and DL.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  Arguments
-*  =========
+*> \date November 2011
+*
+*> \ingroup complex16OTHERcomputational
+*
+*  =====================================================================
+      SUBROUTINE ZGTSV( N, NRHS, DL, D, DU, B, LDB, INFO )
+*
+*  -- 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
 *
-*  N       (input) INTEGER
-*          The order of the matrix A.  N >= 0.
-*
-*  NRHS    (input) INTEGER
-*          The number of right hand sides, i.e., the number of columns
-*          of the matrix B.  NRHS >= 0.
-*
-*  DL      (input/output) COMPLEX*16 array, dimension (N-1)
-*          On entry, DL must contain the (n-1) subdiagonal elements of
-*          A.
-*          On exit, DL is overwritten by the (n-2) elements of the
-*          second superdiagonal of the upper triangular matrix U from
-*          the LU factorization of A, in DL(1), ..., DL(n-2).
-*
-*  D       (input/output) COMPLEX*16 array, dimension (N)
-*          On entry, D must contain the diagonal elements of A.
-*          On exit, D is overwritten by the n diagonal elements of U.
-*
-*  DU      (input/output) COMPLEX*16 array, dimension (N-1)
-*          On entry, DU must contain the (n-1) superdiagonal elements
-*          of A.
-*          On exit, DU is overwritten by the (n-1) elements of the first
-*          superdiagonal of U.
-*
-*  B       (input/output) COMPLEX*16 array, dimension (LDB,NRHS)
-*          On entry, the N-by-NRHS right hand side matrix B.
-*          On exit, if INFO = 0, the N-by-NRHS solution matrix X.
-*
-*  LDB     (input) INTEGER
-*          The leading dimension of the array B.  LDB >= max(1,N).
-*
-*  INFO    (output) INTEGER
-*          = 0:  successful exit
-*          < 0:  if INFO = -i, the i-th argument had an illegal value
-*          > 0:  if INFO = i, U(i,i) is exactly zero, and the solution
-*                has not been computed.  The factorization has not been
-*                completed unless i = N.
+*     .. Scalar Arguments ..
+      INTEGER            INFO, LDB, N, NRHS
+*     ..
+*     .. Array Arguments ..
+      COMPLEX*16         B( LDB, * ), D( * ), DL( * ), DU( * )
+*     ..
 *
 *  =====================================================================
 *