Integrating Doxygen in comments

1 files changed, 113 insertions, 47 deletions

diff --git a/SRC/zptcon.f b/SRC/zptcon.f
index 4131c0f1..503dfe0a 100644
--- a/SRC/zptcon.f
+++ b/SRC/zptcon.f
@@ -1,65 +1,131 @@
-      SUBROUTINE ZPTCON( N, D, E, ANORM, RCOND, RWORK, INFO )
-*
-*  -- 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                                                      --
-*
-*     .. Scalar Arguments ..
-      INTEGER            INFO, N
-      DOUBLE PRECISION   ANORM, RCOND
-*     ..
-*     .. Array Arguments ..
-      DOUBLE PRECISION   D( * ), RWORK( * )
-      COMPLEX*16         E( * )
-*     ..
-*
+*> \brief \b ZPTCON
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE ZPTCON( N, D, E, ANORM, RCOND, RWORK, INFO )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            INFO, N
+*       DOUBLE PRECISION   ANORM, RCOND
+*       ..
+*       .. Array Arguments ..
+*       DOUBLE PRECISION   D( * ), RWORK( * )
+*       COMPLEX*16         E( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  ZPTCON computes the reciprocal of the condition number (in the
-*  1-norm) of a complex Hermitian positive definite tridiagonal matrix
-*  using the factorization A = L*D*L**H or A = U**H*D*U computed by
-*  ZPTTRF.
-*
-*  Norm(inv(A)) is computed by a direct method, and the reciprocal of
-*  the condition number is computed as
-*                   RCOND = 1 / (ANORM * norm(inv(A))).
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> ZPTCON computes the reciprocal of the condition number (in the
+*> 1-norm) of a complex Hermitian positive definite tridiagonal matrix
+*> using the factorization A = L*D*L**H or A = U**H*D*U computed by
+*> ZPTTRF.
+*>
+*> Norm(inv(A)) is computed by a direct method, and the reciprocal of
+*> the condition number is computed as
+*>                  RCOND = 1 / (ANORM * norm(inv(A))).
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  N       (input) INTEGER
-*          The order of the matrix A.  N >= 0.
-*
-*  D       (input) DOUBLE PRECISION array, dimension (N)
-*          The n diagonal elements of the diagonal matrix D from the
-*          factorization of A, as computed by ZPTTRF.
-*
-*  E       (input) COMPLEX*16 array, dimension (N-1)
-*          The (n-1) off-diagonal elements of the unit bidiagonal factor
-*          U or L from the factorization of A, as computed by ZPTTRF.
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The order of the matrix A.  N >= 0.
+*> \endverbatim
+*>
+*> \param[in] D
+*> \verbatim
+*>          D is DOUBLE PRECISION array, dimension (N)
+*>          The n diagonal elements of the diagonal matrix D from the
+*>          factorization of A, as computed by ZPTTRF.
+*> \endverbatim
+*>
+*> \param[in] E
+*> \verbatim
+*>          E is COMPLEX*16 array, dimension (N-1)
+*>          The (n-1) off-diagonal elements of the unit bidiagonal factor
+*>          U or L from the factorization of A, as computed by ZPTTRF.
+*> \endverbatim
+*>
+*> \param[in] ANORM
+*> \verbatim
+*>          ANORM is DOUBLE PRECISION
+*>          The 1-norm of the original matrix A.
+*> \endverbatim
+*>
+*> \param[out] RCOND
+*> \verbatim
+*>          RCOND is DOUBLE PRECISION
+*>          The reciprocal of the condition number of the matrix A,
+*>          computed as RCOND = 1/(ANORM * AINVNM), where AINVNM is the
+*>          1-norm of inv(A) computed in this routine.
+*> \endverbatim
+*>
+*> \param[out] RWORK
+*> \verbatim
+*>          RWORK is DOUBLE PRECISION array, dimension (N)
+*> \endverbatim
+*>
+*> \param[out] INFO
+*> \verbatim
+*>          INFO is INTEGER
+*>          = 0:  successful exit
+*>          < 0:  if INFO = -i, the i-th argument had an illegal value
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  ANORM   (input) DOUBLE PRECISION
-*          The 1-norm of the original matrix A.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  RCOND   (output) DOUBLE PRECISION
-*          The reciprocal of the condition number of the matrix A,
-*          computed as RCOND = 1/(ANORM * AINVNM), where AINVNM is the
-*          1-norm of inv(A) computed in this routine.
+*> \date November 2011
 *
-*  RWORK   (workspace) DOUBLE PRECISION array, dimension (N)
+*> \ingroup complex16OTHERcomputational
 *
-*  INFO    (output) INTEGER
-*          = 0:  successful exit
-*          < 0:  if INFO = -i, the i-th argument had an illegal value
 *
 *  Further Details
 *  ===============
+*>\details \b Further \b Details
+*> \verbatim
+*>
+*>  The method used is described in Nicholas J. Higham, "Efficient
+*>  Algorithms for Computing the Condition Number of a Tridiagonal
+*>  Matrix", SIAM J. Sci. Stat. Comput., Vol. 7, No. 1, January 1986.
+*>
+*> \endverbatim
+*>
+*  =====================================================================
+      SUBROUTINE ZPTCON( N, D, E, ANORM, RCOND, RWORK, INFO )
 *
-*  The method used is described in Nicholas J. Higham, "Efficient
-*  Algorithms for Computing the Condition Number of a Tridiagonal
-*  Matrix", SIAM J. Sci. Stat. Comput., Vol. 7, No. 1, January 1986.
+*  -- 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
+*
+*     .. Scalar Arguments ..
+      INTEGER            INFO, N
+      DOUBLE PRECISION   ANORM, RCOND
+*     ..
+*     .. Array Arguments ..
+      DOUBLE PRECISION   D( * ), RWORK( * )
+      COMPLEX*16         E( * )
+*     ..
 *
 *  =====================================================================
 *