From e1d39294aee16fa6db9ba079b14442358217db71 Mon Sep 17 00:00:00 2001
From: julie <julielangou@users.noreply.github.com>
Date: Thu, 6 Oct 2011 06:53:11 +0000
Subject: Integrating Doxygen in comments

---
 SRC/zla_porpvgrw.f | 137 +++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 97 insertions(+), 40 deletions(-)

(limited to 'SRC/zla_porpvgrw.f')

diff --git a/SRC/zla_porpvgrw.f b/SRC/zla_porpvgrw.f
index 1e168fc2..b25d5e47 100644
--- a/SRC/zla_porpvgrw.f
+++ b/SRC/zla_porpvgrw.f
@@ -1,59 +1,116 @@
-      DOUBLE PRECISION FUNCTION ZLA_PORPVGRW( UPLO, NCOLS, A, LDA, AF, 
-     $                                        LDAF, WORK )
+*> \brief \b ZLA_PORPVGRW
 *
-*     -- 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 ..
-      CHARACTER*1        UPLO
-      INTEGER            NCOLS, LDA, LDAF
-*     ..
-*     .. Array Arguments ..
-      COMPLEX*16         A( LDA, * ), AF( LDAF, * )
-      DOUBLE PRECISION   WORK( * )
-*     ..
+*  Definition
+*  ==========
 *
+*       DOUBLE PRECISION FUNCTION ZLA_PORPVGRW( UPLO, NCOLS, A, LDA, AF, 
+*                                               LDAF, WORK )
+* 
+*       .. Scalar Arguments ..
+*       CHARACTER*1        UPLO
+*       INTEGER            NCOLS, LDA, LDAF
+*       ..
+*       .. Array Arguments ..
+*       COMPLEX*16         A( LDA, * ), AF( LDAF, * )
+*       DOUBLE PRECISION   WORK( * )
+*       ..
+*  
 *  Purpose
 *  =======
-* 
-*  ZLA_PORPVGRW computes the reciprocal pivot growth factor
-*  norm(A)/norm(U). The "max absolute element" norm is used. If this is
-*  much less than 1, the stability of the LU factorization of the
-*  (equilibrated) matrix A could be poor. This also means that the
-*  solution X, estimated condition numbers, and error bounds could be
-*  unreliable.
+*
+*>\details \b Purpose:
+*>\verbatim
+*> 
+*> ZLA_PORPVGRW computes the reciprocal pivot growth factor
+*> norm(A)/norm(U). The "max absolute element" norm is used. If this is
+*> much less than 1, the stability of the LU factorization of the
+*> (equilibrated) matrix A could be poor. This also means that the
+*> solution X, estimated condition numbers, and error bounds could be
+*> unreliable.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*     UPLO    (input) CHARACTER*1
-*       = 'U':  Upper triangle of A is stored;
-*       = 'L':  Lower triangle of A is stored.
+*> \param[in] UPLO
+*> \verbatim
+*>          UPLO is CHARACTER*1
+*>       = 'U':  Upper triangle of A is stored;
+*>       = 'L':  Lower triangle of A is stored.
+*> \endverbatim
+*>
+*> \param[in] NCOLS
+*> \verbatim
+*>          NCOLS is INTEGER
+*>     The number of columns of the matrix A. NCOLS >= 0.
+*> \endverbatim
+*>
+*> \param[in] A
+*> \verbatim
+*>          A is COMPLEX*16 array, dimension (LDA,N)
+*>     On entry, the N-by-N matrix A.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER
+*>     The leading dimension of the array A.  LDA >= max(1,N).
+*> \endverbatim
+*>
+*> \param[in] AF
+*> \verbatim
+*>          AF is COMPLEX*16 array, dimension (LDAF,N)
+*>     The triangular factor U or L from the Cholesky factorization
+*>     A = U**T*U or A = L*L**T, as computed by ZPOTRF.
+*> \endverbatim
+*>
+*> \param[in] LDAF
+*> \verbatim
+*>          LDAF is INTEGER
+*>     The leading dimension of the array AF.  LDAF >= max(1,N).
+*> \endverbatim
+*>
+*> \param[in] WORK
+*> \verbatim
+*>          WORK is COMPLEX*16 array, dimension (2*N)
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*     NCOLS   (input) INTEGER
-*     The number of columns of the matrix A. NCOLS >= 0.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*     A       (input) COMPLEX*16 array, dimension (LDA,N)
-*     On entry, the N-by-N matrix A.
+*> \date November 2011
 *
-*     LDA     (input) INTEGER
-*     The leading dimension of the array A.  LDA >= max(1,N).
+*> \ingroup complex16POcomputational
 *
-*     AF      (input) COMPLEX*16 array, dimension (LDAF,N)
-*     The triangular factor U or L from the Cholesky factorization
-*     A = U**T*U or A = L*L**T, as computed by ZPOTRF.
+*  =====================================================================
+      DOUBLE PRECISION FUNCTION ZLA_PORPVGRW( UPLO, NCOLS, A, LDA, AF, 
+     $                                        LDAF, WORK )
 *
-*     LDAF    (input) INTEGER
-*     The leading dimension of the array AF.  LDAF >= max(1,N).
+*  -- 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
 *
-*     WORK    (input) COMPLEX*16 array, dimension (2*N)
+*     .. Scalar Arguments ..
+      CHARACTER*1        UPLO
+      INTEGER            NCOLS, LDA, LDAF
+*     ..
+*     .. Array Arguments ..
+      COMPLEX*16         A( LDA, * ), AF( LDAF, * )
+      DOUBLE PRECISION   WORK( * )
+*     ..
 *
 *  =====================================================================
 *
-- 
cgit v1.2.3