Integrating Doxygen in comments

1 files changed, 148 insertions, 56 deletions

diff --git a/TESTING/EIG/zlsets.f b/TESTING/EIG/zlsets.f
index e443a263..c86895f4 100644
--- a/TESTING/EIG/zlsets.f
+++ b/TESTING/EIG/zlsets.f
@@ -1,75 +1,167 @@
-      SUBROUTINE ZLSETS( M, P, N, A, AF, LDA, B, BF, LDB, C, CF, D, DF,
-     $                   X, WORK, LWORK, RWORK, RESULT )
+*> \brief \b ZLSETS
 *
-*  -- LAPACK test routine (version 3.1) --
-*     Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd..
-*     November 2006
+*  =========== DOCUMENTATION ===========
 *
-*     .. Scalar Arguments ..
-      INTEGER            LDA, LDB, LWORK, M, N, P
-*     ..
-*     .. Array Arguments ..
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
 *
+*  Definition
+*  ==========
+*
+*       SUBROUTINE ZLSETS( M, P, N, A, AF, LDA, B, BF, LDB, C, CF, D, DF,
+*                          X, WORK, LWORK, RWORK, RESULT )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            LDA, LDB, LWORK, M, N, P
+*       ..
+*       .. Array Arguments ..
+*  
 *  Purpose
 *  =======
 *
-*  ZLSETS tests ZGGLSE - a subroutine for solving linear equality
-*  constrained least square problem (LSE).
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> ZLSETS tests ZGGLSE - a subroutine for solving linear equality
+*> constrained least square problem (LSE).
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  M       (input) INTEGER
-*          The number of rows of the matrix A.  M >= 0.
-*
-*  P       (input) INTEGER
-*          The number of rows of the matrix B.  P >= 0.
-*
-*  N       (input) INTEGER
-*          The number of columns of the matrices A and B.  N >= 0.
-*
-*  A       (input) COMPLEX*16 array, dimension (LDA,N)
-*          The M-by-N matrix A.
-*
-*  AF      (workspace) COMPLEX*16 array, dimension (LDA,N)
-*
-*  LDA     (input) INTEGER
-*          The leading dimension of the arrays A, AF, Q and R.
-*          LDA >= max(M,N).
-*
-*  B       (input) COMPLEX*16 array, dimension (LDB,N)
-*          The P-by-N matrix A.
-*
-*  BF      (workspace) COMPLEX*16 array, dimension (LDB,N)
-*
-*  LDB     (input) INTEGER
-*          The leading dimension of the arrays B, BF, V and S.
-*          LDB >= max(P,N).
-*
-*  C       (input) COMPLEX*16 array, dimension( M )
-*          the vector C in the LSE problem.
-*
-*  CF      (workspace) COMPLEX*16 array, dimension( M )
-*
-*  D       (input) COMPLEX*16 array, dimension( P )
-*          the vector D in the LSE problem.
+*> \param[in] M
+*> \verbatim
+*>          M is INTEGER
+*>          The number of rows of the matrix A.  M >= 0.
+*> \endverbatim
+*>
+*> \param[in] P
+*> \verbatim
+*>          P is INTEGER
+*>          The number of rows of the matrix B.  P >= 0.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The number of columns of the matrices A and B.  N >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*>          A is COMPLEX*16 array, dimension (LDA,N)
+*>          The M-by-N matrix A.
+*> \endverbatim
+*>
+*> \param[out] AF
+*> \verbatim
+*>          AF is COMPLEX*16 array, dimension (LDA,N)
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER
+*>          The leading dimension of the arrays A, AF, Q and R.
+*>          LDA >= max(M,N).
+*> \endverbatim
+*>
+*> \param[in] B
+*> \verbatim
+*>          B is COMPLEX*16 array, dimension (LDB,N)
+*>          The P-by-N matrix A.
+*> \endverbatim
+*>
+*> \param[out] BF
+*> \verbatim
+*>          BF is COMPLEX*16 array, dimension (LDB,N)
+*> \endverbatim
+*>
+*> \param[in] LDB
+*> \verbatim
+*>          LDB is INTEGER
+*>          The leading dimension of the arrays B, BF, V and S.
+*>          LDB >= max(P,N).
+*> \endverbatim
+*>
+*> \param[in] C
+*> \verbatim
+*>          C is COMPLEX*16 array, dimension( M )
+*>          the vector C in the LSE problem.
+*> \endverbatim
+*>
+*> \param[out] CF
+*> \verbatim
+*>          CF is COMPLEX*16 array, dimension( M )
+*> \endverbatim
+*>
+*> \param[in] D
+*> \verbatim
+*>          D is COMPLEX*16 array, dimension( P )
+*>          the vector D in the LSE problem.
+*> \endverbatim
+*>
+*> \param[out] DF
+*> \verbatim
+*>          DF is COMPLEX*16 array, dimension( P )
+*> \endverbatim
+*>
+*> \param[out] X
+*> \verbatim
+*>          X is COMPLEX*16 array, dimension( N )
+*>          solution vector X in the LSE problem.
+*> \endverbatim
+*>
+*> \param[out] WORK
+*> \verbatim
+*>          WORK is COMPLEX*16 array, dimension (LWORK)
+*> \endverbatim
+*>
+*> \param[in] LWORK
+*> \verbatim
+*>          LWORK is INTEGER
+*>          The dimension of the array WORK.
+*> \endverbatim
+*>
+*> \param[out] RWORK
+*> \verbatim
+*>          RWORK is DOUBLE PRECISION array, dimension (M)
+*> \endverbatim
+*>
+*> \param[out] RESULT
+*> \verbatim
+*>          RESULT is DOUBLE PRECISION array, dimension (2)
+*>          The test ratios:
+*>            RESULT(1) = norm( A*x - c )/ norm(A)*norm(X)*EPS
+*>            RESULT(2) = norm( B*x - d )/ norm(B)*norm(X)*EPS
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  DF      (workspace) COMPLEX*16 array, dimension( P )
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  X       (output) COMPLEX*16 array, dimension( N )
-*          solution vector X in the LSE problem.
+*> \date November 2011
 *
-*  WORK    (workspace) COMPLEX*16 array, dimension (LWORK)
+*> \ingroup complex16_eig
 *
-*  LWORK   (input) INTEGER
-*          The dimension of the array WORK.
+*  =====================================================================
+      SUBROUTINE ZLSETS( M, P, N, A, AF, LDA, B, BF, LDB, C, CF, D, DF,
+     $                   X, WORK, LWORK, RWORK, RESULT )
 *
-*  RWORK   (workspace) DOUBLE PRECISION array, dimension (M)
+*  -- LAPACK test routine (version 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
 *
-*  RESULT  (output) DOUBLE PRECISION array, dimension (2)
-*          The test ratios:
-*            RESULT(1) = norm( A*x - c )/ norm(A)*norm(X)*EPS
-*            RESULT(2) = norm( B*x - d )/ norm(B)*norm(X)*EPS
+*     .. Scalar Arguments ..
+      INTEGER            LDA, LDB, LWORK, M, N, P
+*     ..
+*     .. Array Arguments ..
 *
 *  ====================================================================
 *