Integrating Doxygen in comments

1 files changed, 94 insertions, 36 deletions

diff --git a/TESTING/EIG/alareq.f b/TESTING/EIG/alareq.f
index b42cb20e..fc29edcc 100644
--- a/TESTING/EIG/alareq.f
+++ b/TESTING/EIG/alareq.f
@@ -1,51 +1,109 @@
-      SUBROUTINE ALAREQ( PATH, NMATS, DOTYPE, NTYPES, NIN, NOUT )
-*
-*  -- LAPACK test routine (version 3.1) --
-*     Univ. of Tennessee, Univ. of California Berkeley and NAG Ltd..
-*     November 2006
-*
-*     .. Scalar Arguments ..
-      CHARACTER*3        PATH
-      INTEGER            NIN, NMATS, NOUT, NTYPES
-*     ..
-*     .. Array Arguments ..
-      LOGICAL            DOTYPE( * )
-*     ..
-*
+*> \brief \b ALAREQ
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE ALAREQ( PATH, NMATS, DOTYPE, NTYPES, NIN, NOUT )
+* 
+*       .. Scalar Arguments ..
+*       CHARACTER*3        PATH
+*       INTEGER            NIN, NMATS, NOUT, NTYPES
+*       ..
+*       .. Array Arguments ..
+*       LOGICAL            DOTYPE( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  ALAREQ handles input for the LAPACK test program.  It is called
-*  to evaluate the input line which requested NMATS matrix types for
-*  PATH.  The flow of control is as follows:
-*
-*  If NMATS = NTYPES then
-*     DOTYPE(1:NTYPES) = .TRUE.
-*  else
-*     Read the next input line for NMATS matrix types
-*     Set DOTYPE(I) = .TRUE. for each valid type I
-*  endif
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> ALAREQ handles input for the LAPACK test program.  It is called
+*> to evaluate the input line which requested NMATS matrix types for
+*> PATH.  The flow of control is as follows:
+*>
+*> If NMATS = NTYPES then
+*>    DOTYPE(1:NTYPES) = .TRUE.
+*> else
+*>    Read the next input line for NMATS matrix types
+*>    Set DOTYPE(I) = .TRUE. for each valid type I
+*> endif
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  PATH    (input) CHARACTER*3
-*          An LAPACK path name for testing.
+*> \param[in] PATH
+*> \verbatim
+*>          PATH is CHARACTER*3
+*>          An LAPACK path name for testing.
+*> \endverbatim
+*>
+*> \param[in] NMATS
+*> \verbatim
+*>          NMATS is INTEGER
+*>          The number of matrix types to be used in testing this path.
+*> \endverbatim
+*>
+*> \param[out] DOTYPE
+*> \verbatim
+*>          DOTYPE is LOGICAL array, dimension (NTYPES)
+*>          The vector of flags indicating if each type will be tested.
+*> \endverbatim
+*>
+*> \param[in] NTYPES
+*> \verbatim
+*>          NTYPES is INTEGER
+*>          The maximum number of matrix types for this path.
+*> \endverbatim
+*>
+*> \param[in] NIN
+*> \verbatim
+*>          NIN is INTEGER
+*>          The unit number for input.  NIN >= 1.
+*> \endverbatim
+*>
+*> \param[in] NOUT
+*> \verbatim
+*>          NOUT is INTEGER
+*>          The unit number for output.  NOUT >= 1.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
+*
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  NMATS   (input) INTEGER
-*          The number of matrix types to be used in testing this path.
+*> \date November 2011
 *
-*  DOTYPE  (output) LOGICAL array, dimension (NTYPES)
-*          The vector of flags indicating if each type will be tested.
+*> \ingroup aux_eig
 *
-*  NTYPES  (input) INTEGER
-*          The maximum number of matrix types for this path.
+*  =====================================================================
+      SUBROUTINE ALAREQ( PATH, NMATS, DOTYPE, NTYPES, NIN, NOUT )
 *
-*  NIN     (input) INTEGER
-*          The unit number for input.  NIN >= 1.
+*  -- LAPACK test routine (version 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
 *
-*  NOUT    (input) INTEGER
-*          The unit number for output.  NOUT >= 1.
+*     .. Scalar Arguments ..
+      CHARACTER*3        PATH
+      INTEGER            NIN, NMATS, NOUT, NTYPES
+*     ..
+*     .. Array Arguments ..
+      LOGICAL            DOTYPE( * )
+*     ..
 *
 *  =====================================================================
 *