Integrating Doxygen in comments

1 files changed, 122 insertions, 57 deletions

diff --git a/SRC/clacn2.f b/SRC/clacn2.f
index 5b76cde4..ed2ca131 100644
--- a/SRC/clacn2.f
+++ b/SRC/clacn2.f
@@ -1,75 +1,140 @@
-      SUBROUTINE CLACN2( N, V, X, EST, KASE, ISAVE )
-*
-*  -- 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            KASE, N
-      REAL               EST
-*     ..
-*     .. Array Arguments ..
-      INTEGER            ISAVE( 3 )
-      COMPLEX            V( * ), X( * )
-*     ..
-*
+*> \brief \b CLACN2
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE CLACN2( N, V, X, EST, KASE, ISAVE )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            KASE, N
+*       REAL               EST
+*       ..
+*       .. Array Arguments ..
+*       INTEGER            ISAVE( 3 )
+*       COMPLEX            V( * ), X( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  CLACN2 estimates the 1-norm of a square, complex matrix A.
-*  Reverse communication is used for evaluating matrix-vector products.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> CLACN2 estimates the 1-norm of a square, complex matrix A.
+*> Reverse communication is used for evaluating matrix-vector products.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  N      (input) INTEGER
-*         The order of the matrix.  N >= 1.
-*
-*  V      (workspace) COMPLEX array, dimension (N)
-*         On the final return, V = A*W,  where  EST = norm(V)/norm(W)
-*         (W is not returned).
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>         The order of the matrix.  N >= 1.
+*> \endverbatim
+*>
+*> \param[out] V
+*> \verbatim
+*>          V is COMPLEX array, dimension (N)
+*>         On the final return, V = A*W,  where  EST = norm(V)/norm(W)
+*>         (W is not returned).
+*> \endverbatim
+*>
+*> \param[in,out] X
+*> \verbatim
+*>          X is COMPLEX array, dimension (N)
+*>         On an intermediate return, X should be overwritten by
+*>               A * X,   if KASE=1,
+*>               A**H * X,  if KASE=2,
+*>         where A**H is the conjugate transpose of A, and CLACN2 must be
+*>         re-called with all the other parameters unchanged.
+*> \endverbatim
+*>
+*> \param[in,out] EST
+*> \verbatim
+*>          EST is REAL
+*>         On entry with KASE = 1 or 2 and ISAVE(1) = 3, EST should be
+*>         unchanged from the previous call to CLACN2.
+*>         On exit, EST is an estimate (a lower bound) for norm(A). 
+*> \endverbatim
+*>
+*> \param[in,out] KASE
+*> \verbatim
+*>          KASE is INTEGER
+*>         On the initial call to CLACN2, KASE should be 0.
+*>         On an intermediate return, KASE will be 1 or 2, indicating
+*>         whether X should be overwritten by A * X  or A**H * X.
+*>         On the final return from CLACN2, KASE will again be 0.
+*> \endverbatim
+*>
+*> \param[in,out] ISAVE
+*> \verbatim
+*>          ISAVE is INTEGER array, dimension (3)
+*>         ISAVE is used to save variables between calls to SLACN2
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  X      (input/output) COMPLEX array, dimension (N)
-*         On an intermediate return, X should be overwritten by
-*               A * X,   if KASE=1,
-*               A**H * X,  if KASE=2,
-*         where A**H is the conjugate transpose of A, and CLACN2 must be
-*         re-called with all the other parameters unchanged.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  EST    (input/output) REAL
-*         On entry with KASE = 1 or 2 and ISAVE(1) = 3, EST should be
-*         unchanged from the previous call to CLACN2.
-*         On exit, EST is an estimate (a lower bound) for norm(A). 
+*> \date November 2011
 *
-*  KASE   (input/output) INTEGER
-*         On the initial call to CLACN2, KASE should be 0.
-*         On an intermediate return, KASE will be 1 or 2, indicating
-*         whether X should be overwritten by A * X  or A**H * X.
-*         On the final return from CLACN2, KASE will again be 0.
+*> \ingroup complexOTHERauxiliary
 *
-*  ISAVE  (input/output) INTEGER array, dimension (3)
-*         ISAVE is used to save variables between calls to SLACN2
 *
 *  Further Details
-*  ======= =======
-*
-*  Contributed by Nick Higham, University of Manchester.
-*  Originally named CONEST, dated March 16, 1988.
-*
-*  Reference: N.J. Higham, "FORTRAN codes for estimating the one-norm of
-*  a real or complex matrix, with applications to condition estimation",
-*  ACM Trans. Math. Soft., vol. 14, no. 4, pp. 381-396, December 1988.
-*
-*  Last modified:  April, 1999
+*  ===============
+*>\details \b Further \b Details
+*> \verbatim
+*  Further Details
+*>  ======= =======
+*>
+*>  Contributed by Nick Higham, University of Manchester.
+*>  Originally named CONEST, dated March 16, 1988.
+*>
+*>  Reference: N.J. Higham, "FORTRAN codes for estimating the one-norm of
+*>  a real or complex matrix, with applications to condition estimation",
+*>  ACM Trans. Math. Soft., vol. 14, no. 4, pp. 381-396, December 1988.
+*>
+*>  Last modified:  April, 1999
+*>
+*>  This is a thread safe version of CLACON, which uses the array ISAVE
+*>  in place of a SAVE statement, as follows:
+*>
+*>     CLACON     CLACN2
+*>      JUMP     ISAVE(1)
+*>      J        ISAVE(2)
+*>      ITER     ISAVE(3)
+*>
+*> \endverbatim
+*>
+*  =====================================================================
+      SUBROUTINE CLACN2( N, V, X, EST, KASE, ISAVE )
 *
-*  This is a thread safe version of CLACON, which uses the array ISAVE
-*  in place of a SAVE statement, as follows:
+*  -- 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
 *
-*     CLACON     CLACN2
-*      JUMP     ISAVE(1)
-*      J        ISAVE(2)
-*      ITER     ISAVE(3)
+*     .. Scalar Arguments ..
+      INTEGER            KASE, N
+      REAL               EST
+*     ..
+*     .. Array Arguments ..
+      INTEGER            ISAVE( 3 )
+      COMPLEX            V( * ), X( * )
+*     ..
 *
 *  =====================================================================
 *