Integrating Doxygen in comments

1 files changed, 113 insertions, 51 deletions

diff --git a/SRC/zgeqrt2.f b/SRC/zgeqrt2.f
index a78c5c82..56f68ed9 100644
--- a/SRC/zgeqrt2.f
+++ b/SRC/zgeqrt2.f
@@ -1,73 +1,135 @@
-      SUBROUTINE ZGEQRT2( M, N, A, LDA, T, LDT, INFO )
+*> \brief \b ZGEQRT2
 *
-*  -- LAPACK routine (version 3.?) --
-*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
-*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
-*  -- July 2011                                                      --
+*  =========== DOCUMENTATION ===========
 *
-*     .. Scalar Arguments ..
-      INTEGER   INFO, LDA, LDT, M, N
-*     ..
-*     .. Array Arguments ..
-      COMPLEX*16   A( LDA, * ), T( LDT, * )
-*     ..
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
 *
+*       SUBROUTINE ZGEQRT2( M, N, A, LDA, T, LDT, INFO )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER   INFO, LDA, LDT, M, N
+*       ..
+*       .. Array Arguments ..
+*       COMPLEX*16   A( LDA, * ), T( LDT, * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  ZGEQRT2 computes a QR factorization of a complex M-by-N matrix A, 
-*  using the compact WY representation of Q. 
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> ZGEQRT2 computes a QR factorization of a complex M-by-N matrix A, 
+*> using the compact WY representation of Q. 
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  M       (input) INTEGER
-*          The number of rows of the matrix A.  M >= N.
-*
-*  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 complex M-by-N matrix A.  On exit, the elements on and
-*          above the diagonal contain the N-by-N upper triangular matrix R; the
-*          elements below the diagonal are the columns of V.  See below for
-*          further details.
+*> \param[in] M
+*> \verbatim
+*>          M is INTEGER
+*>          The number of rows of the matrix A.  M >= N.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The number of columns of the matrix A.  N >= 0.
+*> \endverbatim
+*>
+*> \param[in,out] A
+*> \verbatim
+*>          A is COMPLEX*16 array, dimension (LDA,N)
+*>          On entry, the complex M-by-N matrix A.  On exit, the elements on and
+*>          above the diagonal contain the N-by-N upper triangular matrix R; the
+*>          elements below the diagonal are the columns of V.  See below for
+*>          further details.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER
+*>          The leading dimension of the array A.  LDA >= max(1,M).
+*> \endverbatim
+*>
+*> \param[out] T
+*> \verbatim
+*>          T is COMPLEX*16 array, dimension (LDT,N)
+*>          The N-by-N upper triangular factor of the block reflector.
+*>          The elements on and above the diagonal contain the block
+*>          reflector T; the elements below the diagonal are not used.
+*>          See below for further details.
+*> \endverbatim
+*> \verbatim
+*>  LDT     (intput) INTEGER
+*>          The leading dimension of the array T.  LDT >= 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
+*> \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. 
 *
-*  T       (output) COMPLEX*16 array, dimension (LDT,N)
-*          The N-by-N upper triangular factor of the block reflector.
-*          The elements on and above the diagonal contain the block
-*          reflector T; the elements below the diagonal are not used.
-*          See below for further details.
+*> \date November 2011
 *
-*  LDT     (intput) INTEGER
-*          The leading dimension of the array T.  LDT >= max(1,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
+*>
+*>  The matrix V stores the elementary reflectors H(i) in the i-th column
+*>  below the diagonal. For example, if M=5 and N=3, the matrix V is
+*>
+*>               V = (  1       )
+*>                   ( v1  1    )
+*>                   ( v1 v2  1 )
+*>                   ( v1 v2 v3 )
+*>                   ( v1 v2 v3 )
+*>
+*>  where the vi's represent the vectors which define H(i), which are returned
+*>  in the matrix A.  The 1's along the diagonal of V are not stored in A.  The
+*>  block reflector H is then given by
+*>
+*>               H = I - V * T * V**H
+*>
+*>  where V**H is the conjugate transpose of V.
+*>
+*> \endverbatim
+*>
+*  =====================================================================
+      SUBROUTINE ZGEQRT2( M, N, A, LDA, T, LDT, INFO )
 *
-*  The matrix V stores the elementary reflectors H(i) in the i-th column
-*  below the diagonal. For example, if M=5 and N=3, the matrix V is
-*
-*               V = (  1       )
-*                   ( v1  1    )
-*                   ( v1 v2  1 )
-*                   ( v1 v2 v3 )
-*                   ( v1 v2 v3 )
-*
-*  where the vi's represent the vectors which define H(i), which are returned
-*  in the matrix A.  The 1's along the diagonal of V are not stored in A.  The
-*  block reflector H is then given by
-*
-*               H = I - V * T * V**H
+*  -- LAPACK computational routine (version 3.?) --
+*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
+*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
+*     November 2011
 *
-*  where V**H is the conjugate transpose of V.
+*     .. Scalar Arguments ..
+      INTEGER   INFO, LDA, LDT, M, N
+*     ..
+*     .. Array Arguments ..
+      COMPLEX*16   A( LDA, * ), T( LDT, * )
+*     ..
 *
 *  =====================================================================
 *