Integrating Doxygen in comments

1 files changed, 143 insertions, 70 deletions

diff --git a/SRC/cupmtr.f b/SRC/cupmtr.f
index c18c2433..9538243a 100644
--- a/SRC/cupmtr.f
+++ b/SRC/cupmtr.f
@@ -1,86 +1,159 @@
-      SUBROUTINE CUPMTR( SIDE, UPLO, TRANS, M, N, AP, TAU, C, LDC, WORK,
-     $                   INFO )
-*
-*  -- 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                                                      --
-*
-*     .. Scalar Arguments ..
-      CHARACTER          SIDE, TRANS, UPLO
-      INTEGER            INFO, LDC, M, N
-*     ..
-*     .. Array Arguments ..
-      COMPLEX            AP( * ), C( LDC, * ), TAU( * ), WORK( * )
-*     ..
-*
+*> \brief \b CUPMTR
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE CUPMTR( SIDE, UPLO, TRANS, M, N, AP, TAU, C, LDC, WORK,
+*                          INFO )
+* 
+*       .. Scalar Arguments ..
+*       CHARACTER          SIDE, TRANS, UPLO
+*       INTEGER            INFO, LDC, M, N
+*       ..
+*       .. Array Arguments ..
+*       COMPLEX            AP( * ), C( LDC, * ), TAU( * ), WORK( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  CUPMTR 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 unitary matrix of order nq, with nq = m if
-*  SIDE = 'L' and nq = n if SIDE = 'R'. Q is defined as the product of
-*  nq-1 elementary reflectors, as returned by CHPTRD using packed
-*  storage:
-*
-*  if UPLO = 'U', Q = H(nq-1) . . . H(2) H(1);
-*
-*  if UPLO = 'L', Q = H(1) H(2) . . . H(nq-1).
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> CUPMTR 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 unitary matrix of order nq, with nq = m if
+*> SIDE = 'L' and nq = n if SIDE = 'R'. Q is defined as the product of
+*> nq-1 elementary reflectors, as returned by CHPTRD using packed
+*> storage:
+*>
+*> if UPLO = 'U', Q = H(nq-1) . . . H(2) H(1);
+*>
+*> if UPLO = 'L', Q = H(1) H(2) . . . H(nq-1).
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  SIDE    (input) CHARACTER*1
-*          = 'L': apply Q or Q**H from the Left;
-*          = 'R': apply Q or Q**H from the Right.
-*
-*  UPLO    (input) CHARACTER*1
-*          = 'U': Upper triangular packed storage used in previous
-*                 call to CHPTRD;
-*          = 'L': Lower triangular packed storage used in previous
-*                 call to CHPTRD.
-*
-*  TRANS   (input) CHARACTER*1
-*          = 'N':  No transpose, apply Q;
-*          = 'C':  Conjugate 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.
+*> \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] UPLO
+*> \verbatim
+*>          UPLO is CHARACTER*1
+*>          = 'U': Upper triangular packed storage used in previous
+*>                 call to CHPTRD;
+*>          = 'L': Lower triangular packed storage used in previous
+*>                 call to CHPTRD.
+*> \endverbatim
+*>
+*> \param[in] TRANS
+*> \verbatim
+*>          TRANS is CHARACTER*1
+*>          = 'N':  No transpose, apply Q;
+*>          = 'C':  Conjugate 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] AP
+*> \verbatim
+*>          AP is COMPLEX array, dimension
+*>                               (M*(M+1)/2) if SIDE = 'L'
+*>                               (N*(N+1)/2) if SIDE = 'R'
+*>          The vectors which define the elementary reflectors, as
+*>          returned by CHPTRD.  AP is modified by the routine but
+*>          restored on exit.
+*> \endverbatim
+*>
+*> \param[in] TAU
+*> \verbatim
+*>          TAU is COMPLEX array, dimension (M-1) if SIDE = 'L'
+*>                                     or (N-1) if SIDE = 'R'
+*>          TAU(i) must contain the scalar factor of the elementary
+*>          reflector H(i), as returned by CHPTRD.
+*> \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 or Q**H*C or 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, dimension
+*>                                   (N) if SIDE = 'L'
+*>                                   (M) 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
+*  =======
 *
-*  AP      (input) COMPLEX array, dimension
-*                               (M*(M+1)/2) if SIDE = 'L'
-*                               (N*(N+1)/2) if SIDE = 'R'
-*          The vectors which define the elementary reflectors, as
-*          returned by CHPTRD.  AP is modified by the routine but
-*          restored on exit.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  TAU     (input) COMPLEX array, dimension (M-1) if SIDE = 'L'
-*                                     or (N-1) if SIDE = 'R'
-*          TAU(i) must contain the scalar factor of the elementary
-*          reflector H(i), as returned by CHPTRD.
+*> \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 or Q**H*C or C*Q**H or C*Q.
+*> \ingroup complexOTHERcomputational
 *
-*  LDC     (input) INTEGER
-*          The leading dimension of the array C. LDC >= max(1,M).
+*  =====================================================================
+      SUBROUTINE CUPMTR( SIDE, UPLO, TRANS, M, N, AP, TAU, C, LDC, WORK,
+     $                   INFO )
 *
-*  WORK    (workspace) COMPLEX array, dimension
-*                                   (N) if SIDE = 'L'
-*                                   (M) if SIDE = 'R'
+*  -- 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
 *
-*  INFO    (output) INTEGER
-*          = 0:  successful exit
-*          < 0:  if INFO = -i, the i-th argument had an illegal value
+*     .. Scalar Arguments ..
+      CHARACTER          SIDE, TRANS, UPLO
+      INTEGER            INFO, LDC, M, N
+*     ..
+*     .. Array Arguments ..
+      COMPLEX            AP( * ), C( LDC, * ), TAU( * ), WORK( * )
+*     ..
 *
 *  =====================================================================
 *