Integrating Doxygen in comments

1 files changed, 161 insertions, 80 deletions

diff --git a/SRC/cgemqrt.f b/SRC/cgemqrt.f
index 2307da83..3a969397 100644
--- a/SRC/cgemqrt.f
+++ b/SRC/cgemqrt.f
@@ -1,96 +1,177 @@
-      SUBROUTINE CGEMQRT( SIDE, TRANS, M, N, K, NB, V, LDV, T, LDT, 
-     $                   C, LDC, WORK, INFO )
-      IMPLICIT NONE
-*
-*  -- 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 --
-*
-*     .. Scalar Arguments ..
-      CHARACTER SIDE, TRANS
-      INTEGER   INFO, K, LDV, LDC, M, N, NB, LDT
-*     ..
-*     .. Array Arguments ..
-      COMPLEX   V( LDV, * ), C( LDC, * ), T( LDT, * ), WORK( * )
-*     ..
-*
+*> \brief \b CGEMQRT
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE CGEMQRT( SIDE, TRANS, M, N, K, NB, V, LDV, T, LDT, 
+*                          C, LDC, WORK, INFO )
+* 
+*       .. Scalar Arguments ..
+*       CHARACTER SIDE, TRANS
+*       INTEGER   INFO, K, LDV, LDC, M, N, NB, LDT
+*       ..
+*       .. Array Arguments ..
+*       COMPLEX   V( LDV, * ), C( LDC, * ), T( LDT, * ), WORK( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  CGEMQRT overwrites the general complex M-by-N matrix C with
-*
-*                  SIDE = 'L'     SIDE = 'R'
-*  TRANS = 'N':      Q C            C Q
-*  TRANS = 'C':    Q**H C            C Q**H
-*
-*  where Q is a complex orthogonal matrix defined as the product of K
-*  elementary reflectors:
-*
-*        Q = H(1) H(2) . . . H(K) = I - V T V**H
-*
-*  generated using the compact WY representation as returned by CGEQRT. 
-*
-*  Q is of order M if SIDE = 'L' and of order N  if SIDE = 'R'.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> CGEMQRT overwrites the general complex M-by-N matrix C with
+*>
+*>                 SIDE = 'L'     SIDE = 'R'
+*> TRANS = 'N':      Q C            C Q
+*> TRANS = 'C':    Q**H C            C Q**H
+*>
+*> where Q is a complex orthogonal matrix defined as the product of K
+*> elementary reflectors:
+*>
+*>       Q = H(1) H(2) . . . H(K) = I - V T V**H
+*>
+*> generated using the compact WY representation as returned by CGEQRT. 
+*>
+*> Q is of order M if SIDE = 'L' and of order N  if SIDE = 'R'.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  SIDE    (input) CHARACTER*1
-*          = 'L': apply Q or Q**H from the Left;
-*          = 'R': apply Q or Q**H from the Right.
-*
-*  TRANS   (input) CHARACTER*1
-*          = 'N':  No transpose, apply Q;
-*          = 'C':  Transpose, apply Q**H.
-*
-*  M       (input) INTEGER
-*          The number of rows of the matrix C. M >= 0.
-*
-*  N       (input) INTEGER
-*          The number of columns of the matrix C. N >= 0.
-*
-*  K       (input) INTEGER
-*          The number of elementary reflectors whose product defines
-*          the matrix Q.
-*          If SIDE = 'L', M >= K >= 0;
-*          if SIDE = 'R', N >= K >= 0.
-*
-*  NB      (input) INTEGER
-*          The block size used for the storage of T.  K >= NB >= 1.
-*          This must be the same value of NB used to generate T
-*          in CGEQRT.
-*
-*  V       (input) COMPLEX array, dimension (LDV,K)
-*          The i-th column must contain the vector which defines the
-*          elementary reflector H(i), for i = 1,2,...,k, as returned by
-*          CGEQRT in the first K columns of its array argument A.
-*
-*  LDV     (input) INTEGER
-*          The leading dimension of the array V.
-*          If SIDE = 'L', LDA >= max(1,M);
-*          if SIDE = 'R', LDA >= max(1,N).
+*> \param[in] SIDE
+*> \verbatim
+*>          SIDE is CHARACTER*1
+*>          = 'L': apply Q or Q**H from the Left;
+*>          = 'R': apply Q or Q**H from the Right.
+*> \endverbatim
+*>
+*> \param[in] TRANS
+*> \verbatim
+*>          TRANS is CHARACTER*1
+*>          = 'N':  No transpose, apply Q;
+*>          = 'C':  Transpose, apply Q**H.
+*> \endverbatim
+*>
+*> \param[in] M
+*> \verbatim
+*>          M is INTEGER
+*>          The number of rows of the matrix C. M >= 0.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The number of columns of the matrix C. N >= 0.
+*> \endverbatim
+*>
+*> \param[in] K
+*> \verbatim
+*>          K is INTEGER
+*>          The number of elementary reflectors whose product defines
+*>          the matrix Q.
+*>          If SIDE = 'L', M >= K >= 0;
+*>          if SIDE = 'R', N >= K >= 0.
+*> \endverbatim
+*>
+*> \param[in] NB
+*> \verbatim
+*>          NB is INTEGER
+*>          The block size used for the storage of T.  K >= NB >= 1.
+*>          This must be the same value of NB used to generate T
+*>          in CGEQRT.
+*> \endverbatim
+*>
+*> \param[in] V
+*> \verbatim
+*>          V is COMPLEX array, dimension (LDV,K)
+*>          The i-th column must contain the vector which defines the
+*>          elementary reflector H(i), for i = 1,2,...,k, as returned by
+*>          CGEQRT in the first K columns of its array argument A.
+*> \endverbatim
+*>
+*> \param[in] LDV
+*> \verbatim
+*>          LDV is INTEGER
+*>          The leading dimension of the array V.
+*>          If SIDE = 'L', LDA >= max(1,M);
+*>          if SIDE = 'R', LDA >= max(1,N).
+*> \endverbatim
+*>
+*> \param[in] T
+*> \verbatim
+*>          T is COMPLEX array, dimension (LDT,K)
+*>          The upper triangular factors of the block reflectors
+*>          as returned by CGEQRT, stored as a NB-by-N matrix.
+*> \endverbatim
+*>
+*> \param[in] LDT
+*> \verbatim
+*>          LDT is INTEGER
+*>          The leading dimension of the array T.  LDT >= NB.
+*> \endverbatim
+*>
+*> \param[in,out] C
+*> \verbatim
+*>          C is COMPLEX array, dimension (LDC,N)
+*>          On entry, the M-by-N matrix C.
+*>          On exit, C is overwritten by Q C, Q**H C, C Q**H or C Q.
+*> \endverbatim
+*>
+*> \param[in] LDC
+*> \verbatim
+*>          LDC is INTEGER
+*>          The leading dimension of the array C. LDC >= max(1,M).
+*> \endverbatim
+*>
+*> \param[out] WORK
+*> \verbatim
+*>          WORK is COMPLEX array. The dimension of WORK is
+*>           N*NB if SIDE = 'L', or  M*NB if SIDE = 'R'.
+*> \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
+*  =======
 *
-*  T       (input) COMPLEX array, dimension (LDT,K)
-*          The upper triangular factors of the block reflectors
-*          as returned by CGEQRT, stored as a NB-by-N matrix.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  LDT     (input) INTEGER
-*          The leading dimension of the array T.  LDT >= NB.
+*> \date November 2011
 *
-*  C       (input/output) COMPLEX array, dimension (LDC,N)
-*          On entry, the M-by-N matrix C.
-*          On exit, C is overwritten by Q C, Q**H C, C Q**H or C Q.
+*> \ingroup complexGEcomputational
 *
-*  LDC     (input) INTEGER
-*          The leading dimension of the array C. LDC >= max(1,M).
+*  =====================================================================
+      SUBROUTINE CGEMQRT( SIDE, TRANS, M, N, K, NB, V, LDV, T, LDT, 
+     $                   C, LDC, WORK, INFO )
 *
-*  WORK    (workspace/output) COMPLEX array.  The dimension of WORK is
-*           N*NB if SIDE = 'L', or  M*NB if SIDE = 'R'.
+*  -- 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
 *
-*  INFO    (output) INTEGER
-*          = 0:  successful exit
-*          < 0:  if INFO = -i, the i-th argument had an illegal value
+*     .. Scalar Arguments ..
+      CHARACTER SIDE, TRANS
+      INTEGER   INFO, K, LDV, LDC, M, N, NB, LDT
+*     ..
+*     .. Array Arguments ..
+      COMPLEX   V( LDV, * ), C( LDC, * ), T( LDT, * ), WORK( * )
+*     ..
 *
 *  =====================================================================
 *