Integrating Doxygen in comments

1 files changed, 97 insertions, 45 deletions

diff --git a/SRC/dla_lin_berr.f b/SRC/dla_lin_berr.f
index b0893524..fb1feaaf 100644
--- a/SRC/dla_lin_berr.f
+++ b/SRC/dla_lin_berr.f
@@ -1,15 +1,103 @@
-      SUBROUTINE DLA_LIN_BERR ( N, NZ, NRHS, RES, AYB, BERR )
+*> \brief \b DLA_LIN_BERR
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE DLA_LIN_BERR ( N, NZ, NRHS, RES, AYB, BERR )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            N, NZ, NRHS
+*       ..
+*       .. Array Arguments ..
+*       DOUBLE PRECISION   AYB( N, NRHS ), BERR( NRHS )
+*       DOUBLE PRECISION   RES( N, NRHS )
+*       ..
+*  
+*  Purpose
+*  =======
 *
-*     -- LAPACK routine (version 3.2.2)                                 --
-*     -- Contributed by James Demmel, Deaglan Halligan, Yozo Hida and --
-*     -- Jason Riedy of Univ. of California Berkeley.                 --
-*     -- June 2010                                                    --
+*>\details \b Purpose:
+*>\verbatim
+*>
+*>    DLA_LIN_BERR computes component-wise relative backward error from
+*>    the formula
+*>        max(i) ( abs(R(i)) / ( abs(op(A_s))*abs(Y) + abs(B_s) )(i) )
+*>    where abs(Z) is the component-wise absolute value of the matrix
+*>    or vector Z.
+*>
+*>\endverbatim
 *
-*     -- LAPACK is a software package provided by Univ. of Tennessee, --
-*     -- Univ. of California Berkeley and NAG Ltd.                    --
+*  Arguments
+*  =========
+*
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>     The number of linear equations, i.e., the order of the
+*>     matrix A.  N >= 0.
+*> \endverbatim
+*>
+*> \param[in] NZ
+*> \verbatim
+*>          NZ is INTEGER
+*>     We add (NZ+1)*SLAMCH( 'Safe minimum' ) to R(i) in the numerator to
+*>     guard against spuriously zero residuals. Default value is N.
+*> \endverbatim
+*>
+*> \param[in] NRHS
+*> \verbatim
+*>          NRHS is INTEGER
+*>     The number of right hand sides, i.e., the number of columns
+*>     of the matrices AYB, RES, and BERR.  NRHS >= 0.
+*> \endverbatim
+*>
+*> \param[in] RES
+*> \verbatim
+*>          RES is DOUBLE PRECISION array, dimension (N,NRHS)
+*>     The residual matrix, i.e., the matrix R in the relative backward
+*>     error formula above.
+*> \endverbatim
+*>
+*> \param[in] AYB
+*> \verbatim
+*>          AYB is DOUBLE PRECISION array, dimension (N, NRHS)
+*>     The denominator in the relative backward error formula above, i.e.,
+*>     the matrix abs(op(A_s))*abs(Y) + abs(B_s). The matrices A, Y, and B
+*>     are from iterative refinement (see dla_gerfsx_extended.f).
+*>     
+*> \param[out] BERR
+*> \verbatim
+*>          BERR is DOUBLE PRECISION array, dimension (NRHS)
+*>     The component-wise relative backward error from the formula above.
+*> \endverbatim
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
+*
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
+*
+*> \date November 2011
+*
+*> \ingroup doubleOTHERcomputational
+*
+*  =====================================================================
+      SUBROUTINE DLA_LIN_BERR ( N, NZ, NRHS, RES, AYB, BERR )
+*
+*  -- 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
 *
-      IMPLICIT NONE
-*     ..
 *     .. Scalar Arguments ..
       INTEGER            N, NZ, NRHS
 *     ..
@@ -18,42 +106,6 @@
       DOUBLE PRECISION   RES( N, NRHS )
 *     ..
 *
-*  Purpose
-*  =======
-*
-*     DLA_LIN_BERR computes component-wise relative backward error from
-*     the formula
-*         max(i) ( abs(R(i)) / ( abs(op(A_s))*abs(Y) + abs(B_s) )(i) )
-*     where abs(Z) is the component-wise absolute value of the matrix
-*     or vector Z.
-*
-*  Arguments
-*  =========
-*
-*     N       (input) INTEGER
-*     The number of linear equations, i.e., the order of the
-*     matrix A.  N >= 0.
-*
-*     NZ      (input) INTEGER
-*     We add (NZ+1)*SLAMCH( 'Safe minimum' ) to R(i) in the numerator to
-*     guard against spuriously zero residuals. Default value is N.
-*
-*     NRHS    (input) INTEGER
-*     The number of right hand sides, i.e., the number of columns
-*     of the matrices AYB, RES, and BERR.  NRHS >= 0.
-*
-*     RES     (input) DOUBLE PRECISION array, dimension (N,NRHS)
-*     The residual matrix, i.e., the matrix R in the relative backward
-*     error formula above.
-*
-*     AYB     (input) DOUBLE PRECISION array, dimension (N, NRHS)
-*     The denominator in the relative backward error formula above, i.e.,
-*     the matrix abs(op(A_s))*abs(Y) + abs(B_s). The matrices A, Y, and B
-*     are from iterative refinement (see dla_gerfsx_extended.f).
-*     
-*     BERR    (output) DOUBLE PRECISION array, dimension (NRHS)
-*     The component-wise relative backward error from the formula above.
-*
 *  =====================================================================
 *
 *     .. Local Scalars ..