Integrating Doxygen in comments

1 files changed, 88 insertions, 47 deletions

diff --git a/SRC/zgeql2.f b/SRC/zgeql2.f
index f3ab7e16..85470147 100644
--- a/SRC/zgeql2.f
+++ b/SRC/zgeql2.f
@@ -1,69 +1,110 @@
-      SUBROUTINE ZGEQL2( M, N, A, LDA, TAU, WORK, INFO )
+*> \brief \b ZGEQL2
 *
-*  -- 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, LDA, M, N
-*     ..
-*     .. Array Arguments ..
-      COMPLEX*16         A( LDA, * ), TAU( * ), WORK( * )
-*     ..
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
 *
+*  Definition
+*  ==========
+*
+*       SUBROUTINE ZGEQL2( M, N, A, LDA, TAU, WORK, INFO )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            INFO, LDA, M, N
+*       ..
+*       .. Array Arguments ..
+*       COMPLEX*16         A( LDA, * ), TAU( * ), WORK( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  ZGEQL2 computes a QL factorization of a complex m by n matrix A:
-*  A = Q * L.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> ZGEQL2 computes a QL factorization of a complex m by n matrix A:
+*> A = Q * L.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  M       (input) INTEGER
-*          The number of rows of the matrix A.  M >= 0.
-*
-*  N       (input) INTEGER
-*          The number of columns of the matrix A.  N >= 0.
-*
-*  A       (input/output) COMPLEX*16 array, dimension (LDA,N)
-*          On entry, the m by n matrix A.
-*          On exit, if m >= n, the lower triangle of the subarray
-*          A(m-n+1:m,1:n) contains the n by n lower triangular matrix L;
-*          if m <= n, the elements on and below the (n-m)-th
-*          superdiagonal contain the m by n lower trapezoidal matrix L;
-*          the remaining elements, with the array TAU, represent the
-*          unitary matrix Q as a product of elementary reflectors
-*          (see Further Details).
+*> \param[in] M
+*> \verbatim
+*>          M is INTEGER
+*>          The number of rows of the matrix A.  M >= 0.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The number of columns of the matrix A.  N >= 0.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  LDA     (input) INTEGER
-*          The leading dimension of the array A.  LDA >= max(1,M).
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  TAU     (output) COMPLEX*16 array, dimension (min(M,N))
-*          The scalar factors of the elementary reflectors (see Further
-*          Details).
+*> \date November 2011
 *
-*  WORK    (workspace) COMPLEX*16 array, dimension (N)
+*> \ingroup complex16GEcomputational
 *
-*  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
+*          (see Further Details).
+*>
+*>  LDA     (input) INTEGER
+*>          The leading dimension of the array A.  LDA >= max(1,M).
+*>
+*>  TAU     (output) COMPLEX*16 array, dimension (min(M,N))
+*>          The scalar factors of the elementary reflectors (see Further
+*>          Details).
+*>
+*>  WORK    (workspace) COMPLEX*16 array, dimension (N)
+*>
+*>  INFO    (output) INTEGER
+*>          = 0: successful exit
+*>          < 0: if INFO = -i, the i-th argument had an illegal value
+*>
+*>
+*>  The matrix Q is represented as a product of elementary reflectors
+*>
+*>     Q = H(k) . . . H(2) H(1), where k = min(m,n).
+*>
+*>  Each H(i) has the form
+*>
+*>     H(i) = I - tau * v * v**H
+*>
+*>  where tau is a complex scalar, and v is a complex vector with
+*>  v(m-k+i+1:m) = 0 and v(m-k+i) = 1; v(1:m-k+i-1) is stored on exit in
+*>  A(1:m-k+i-1,n-k+i), and tau in TAU(i).
+*>
+*> \endverbatim
+*>
+*  =====================================================================
+      SUBROUTINE ZGEQL2( M, N, A, LDA, TAU, WORK, INFO )
 *
-*  The matrix Q is represented as a product of elementary reflectors
-*
-*     Q = H(k) . . . H(2) H(1), where k = min(m,n).
-*
-*  Each H(i) has the form
-*
-*     H(i) = I - tau * v * v**H
+*  -- 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
 *
-*  where tau is a complex scalar, and v is a complex vector with
-*  v(m-k+i+1:m) = 0 and v(m-k+i) = 1; v(1:m-k+i-1) is stored on exit in
-*  A(1:m-k+i-1,n-k+i), and tau in TAU(i).
+*     .. Scalar Arguments ..
+      INTEGER            INFO, LDA, M, N
+*     ..
+*     .. Array Arguments ..
+      COMPLEX*16         A( LDA, * ), TAU( * ), WORK( * )
+*     ..
 *
 *  =====================================================================
 *