Integrating Doxygen in comments

1 files changed, 174 insertions, 99 deletions

diff --git a/SRC/cla_syamv.f b/SRC/cla_syamv.f
index 85f630fe..13558066 100644
--- a/SRC/cla_syamv.f
+++ b/SRC/cla_syamv.f
@@ -1,120 +1,195 @@
-      SUBROUTINE CLA_SYAMV( UPLO, N, ALPHA, A, LDA, X, INCX, BETA, Y,
-     $                      INCY )
+*> \brief \b CLA_SYAMV
 *
-*     -- LAPACK routine (version 3.2.2)                                 --
-*     -- Contributed by James Demmel, Deaglan Halligan, Yozo Hida and --
-*     -- Jason Riedy of Univ. of California Berkeley.                 --
-*     -- June 2010                                                    --
+*  =========== DOCUMENTATION ===========
 *
-*     -- LAPACK is a software package provided by Univ. of Tennessee, --
-*     -- Univ. of California Berkeley and NAG Ltd.                    --
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
 *
-      IMPLICIT NONE
-*     ..
-*     .. Scalar Arguments ..
-      REAL               ALPHA, BETA
-      INTEGER            INCX, INCY, LDA, N
-      INTEGER            UPLO
-*     ..
-*     .. Array Arguments ..
-      COMPLEX            A( LDA, * ), X( * )
-      REAL               Y( * )
-*     ..
+*  Definition
+*  ==========
 *
+*       SUBROUTINE CLA_SYAMV( UPLO, N, ALPHA, A, LDA, X, INCX, BETA, Y,
+*                             INCY )
+* 
+*       .. Scalar Arguments ..
+*       REAL               ALPHA, BETA
+*       INTEGER            INCX, INCY, LDA, N
+*       INTEGER            UPLO
+*       ..
+*       .. Array Arguments ..
+*       COMPLEX            A( LDA, * ), X( * )
+*       REAL               Y( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  CLA_SYAMV  performs the matrix-vector operation
-*
-*          y := alpha*abs(A)*abs(x) + beta*abs(y),
-*
-*  where alpha and beta are scalars, x and y are vectors and A is an
-*  n by n symmetric matrix.
-*
-*  This function is primarily used in calculating error bounds.
-*  To protect against underflow during evaluation, components in
-*  the resulting vector are perturbed away from zero by (N+1)
-*  times the underflow threshold.  To prevent unnecessarily large
-*  errors for block-structure embedded in general matrices,
-*  "symbolically" zero components are not perturbed.  A zero
-*  entry is considered "symbolic" if all multiplications involved
-*  in computing that entry have at least one zero multiplicand.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> CLA_SYAMV  performs the matrix-vector operation
+*>
+*>         y := alpha*abs(A)*abs(x) + beta*abs(y),
+*>
+*> where alpha and beta are scalars, x and y are vectors and A is an
+*> n by n symmetric matrix.
+*>
+*> This function is primarily used in calculating error bounds.
+*> To protect against underflow during evaluation, components in
+*> the resulting vector are perturbed away from zero by (N+1)
+*> times the underflow threshold.  To prevent unnecessarily large
+*> errors for block-structure embedded in general matrices,
+*> "symbolically" zero components are not perturbed.  A zero
+*> entry is considered "symbolic" if all multiplications involved
+*> in computing that entry have at least one zero multiplicand.
+*>
+*>\endverbatim
 *
 *  Arguments
-*  ==========
-*
-*  UPLO    (input) INTEGER
-*           On entry, UPLO specifies whether the upper or lower
-*           triangular part of the array A is to be referenced as
-*           follows:
-*
-*              UPLO = BLAS_UPPER   Only the upper triangular part of A
-*                                  is to be referenced.
-*
-*              UPLO = BLAS_LOWER   Only the lower triangular part of A
-*                                  is to be referenced.
-*
-*           Unchanged on exit.
-*
-*  N       (input) INTEGER
-*           On entry, N specifies the number of columns of the matrix A.
-*           N must be at least zero.
-*           Unchanged on exit.
-*
-*  ALPHA   (input) REAL            .
-*           On entry, ALPHA specifies the scalar alpha.
-*           Unchanged on exit.
-*
-*  A        (input) COMPLEX array of DIMENSION ( LDA, n ).
-*           Before entry, the leading m by n part of the array A must
-*           contain the matrix of coefficients.
-*           Unchanged on exit.
-*
-*  LDA     (input) INTEGER
-*           On entry, LDA specifies the first dimension of A as declared
-*           in the calling (sub) program. LDA must be at least
-*           max( 1, n ).
-*           Unchanged on exit.
-*
-*  X       (input) COMPLEX array, dimension
-*           ( 1 + ( n - 1 )*abs( INCX ) )
-*           Before entry, the incremented array X must contain the
-*           vector x.
-*           Unchanged on exit.
+*  =========
+*
+*> \param[in] UPLO
+*> \verbatim
+*>          UPLO is INTEGER
+*>           On entry, UPLO specifies whether the upper or lower
+*>           triangular part of the array A is to be referenced as
+*>           follows:
+*> \endverbatim
+*> \verbatim
+*>              UPLO = BLAS_UPPER   Only the upper triangular part of A
+*>                                  is to be referenced.
+*> \endverbatim
+*> \verbatim
+*>              UPLO = BLAS_LOWER   Only the lower triangular part of A
+*>                                  is to be referenced.
+*> \endverbatim
+*> \verbatim
+*>           Unchanged on exit.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>           On entry, N specifies the number of columns of the matrix A.
+*>           N must be at least zero.
+*>           Unchanged on exit.
+*> \endverbatim
+*>
+*> \param[in] ALPHA
+*> \verbatim
+*>          ALPHA is REAL .
+*>           On entry, ALPHA specifies the scalar alpha.
+*>           Unchanged on exit.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*>          A is COMPLEX array of DIMENSION ( LDA, n ).
+*>           Before entry, the leading m by n part of the array A must
+*>           contain the matrix of coefficients.
+*>           Unchanged on exit.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER
+*>           On entry, LDA specifies the first dimension of A as declared
+*>           in the calling (sub) program. LDA must be at least
+*>           max( 1, n ).
+*>           Unchanged on exit.
+*> \endverbatim
+*>
+*> \param[in] X
+*> \verbatim
+*>          X is COMPLEX array, dimension
+*>           ( 1 + ( n - 1 )*abs( INCX ) )
+*>           Before entry, the incremented array X must contain the
+*>           vector x.
+*>           Unchanged on exit.
+*> \endverbatim
+*>
+*> \param[in] INCX
+*> \verbatim
+*>          INCX is INTEGER
+*>           On entry, INCX specifies the increment for the elements of
+*>           X. INCX must not be zero.
+*>           Unchanged on exit.
+*> \endverbatim
+*>
+*> \param[in] BETA
+*> \verbatim
+*>          BETA is REAL .
+*>           On entry, BETA specifies the scalar beta. When BETA is
+*>           supplied as zero then Y need not be set on input.
+*>           Unchanged on exit.
+*> \endverbatim
+*>
+*> \param[in,out] Y
+*> \verbatim
+*>          Y is REAL array, dimension
+*>           ( 1 + ( n - 1 )*abs( INCY ) )
+*>           Before entry with BETA non-zero, the incremented array Y
+*>           must contain the vector y. On exit, Y is overwritten by the
+*>           updated vector y.
+*> \endverbatim
+*>
+*> \param[in] INCY
+*> \verbatim
+*>          INCY is INTEGER
+*>           On entry, INCY specifies the increment for the elements of
+*>           Y. INCY must not be zero.
+*>           Unchanged on exit.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  INCX    (input) INTEGER
-*           On entry, INCX specifies the increment for the elements of
-*           X. INCX must not be zero.
-*           Unchanged on exit.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  BETA    (input) REAL            .
-*           On entry, BETA specifies the scalar beta. When BETA is
-*           supplied as zero then Y need not be set on input.
-*           Unchanged on exit.
+*> \date November 2011
 *
-*  Y       (input/output) REAL array, dimension
-*           ( 1 + ( n - 1 )*abs( INCY ) )
-*           Before entry with BETA non-zero, the incremented array Y
-*           must contain the vector y. On exit, Y is overwritten by the
-*           updated vector y.
+*> \ingroup complexSYcomputational
 *
-*  INCY    (input) INTEGER
-*           On entry, INCY specifies the increment for the elements of
-*           Y. INCY must not be zero.
-*           Unchanged on exit.
 *
 *  Further Details
 *  ===============
+*>\details \b Further \b Details
+*> \verbatim
+*>
+*>  Level 2 Blas routine.
+*>
+*>  -- Written on 22-October-1986.
+*>     Jack Dongarra, Argonne National Lab.
+*>     Jeremy Du Croz, Nag Central Office.
+*>     Sven Hammarling, Nag Central Office.
+*>     Richard Hanson, Sandia National Labs.
+*>  -- Modified for the absolute-value product, April 2006
+*>     Jason Riedy, UC Berkeley
+*>
+*> \endverbatim
+*>
+*  =====================================================================
+      SUBROUTINE CLA_SYAMV( UPLO, N, ALPHA, A, LDA, X, INCX, BETA, Y,
+     $                      INCY )
 *
-*  Level 2 Blas routine.
+*  -- LAPACK computational routine (version 3.2.2) --
+*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
+*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
+*     November 2011
 *
-*  -- Written on 22-October-1986.
-*     Jack Dongarra, Argonne National Lab.
-*     Jeremy Du Croz, Nag Central Office.
-*     Sven Hammarling, Nag Central Office.
-*     Richard Hanson, Sandia National Labs.
-*  -- Modified for the absolute-value product, April 2006
-*     Jason Riedy, UC Berkeley
+*     .. Scalar Arguments ..
+      REAL               ALPHA, BETA
+      INTEGER            INCX, INCY, LDA, N
+      INTEGER            UPLO
+*     ..
+*     .. Array Arguments ..
+      COMPLEX            A( LDA, * ), X( * )
+      REAL               Y( * )
+*     ..
 *
 *  =====================================================================
 *