Integrating Doxygen in comments

1 files changed, 100 insertions, 39 deletions

diff --git a/SRC/claqr1.f b/SRC/claqr1.f
index a9224b78..dab88ddb 100644
--- a/SRC/claqr1.f
+++ b/SRC/claqr1.f
@@ -1,57 +1,118 @@
-      SUBROUTINE CLAQR1( N, H, LDH, S1, S2, V )
-*
-*  -- LAPACK auxiliary routine (version 3.2) --
-*     Univ. of Tennessee, Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..
-*     November 2006
-*
-*     .. Scalar Arguments ..
-      COMPLEX            S1, S2
-      INTEGER            LDH, N
-*     ..
-*     .. Array Arguments ..
-      COMPLEX            H( LDH, * ), V( * )
-*     ..
-*
+*> \brief \b CLAQR1
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE CLAQR1( N, H, LDH, S1, S2, V )
+* 
+*       .. Scalar Arguments ..
+*       COMPLEX            S1, S2
+*       INTEGER            LDH, N
+*       ..
+*       .. Array Arguments ..
+*       COMPLEX            H( LDH, * ), V( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*       Given a 2-by-2 or 3-by-3 matrix H, CLAQR1 sets v to a
-*       scalar multiple of the first column of the product
-*
-*       (*)  K = (H - s1*I)*(H - s2*I)
-*
-*       scaling to avoid overflows and most underflows.
-*
-*       This is useful for starting double implicit shift bulges
-*       in the QR algorithm.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*>      Given a 2-by-2 or 3-by-3 matrix H, CLAQR1 sets v to a
+*>      scalar multiple of the first column of the product
+*>
+*>      (*)  K = (H - s1*I)*(H - s2*I)
+*>
+*>      scaling to avoid overflows and most underflows.
+*>
+*>      This is useful for starting double implicit shift bulges
+*>      in the QR algorithm.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*       N      (input) integer
-*              Order of the matrix H. N must be either 2 or 3.
-*
-*       H      (input) COMPLEX array of dimension (LDH,N)
-*              The 2-by-2 or 3-by-3 matrix H in (*).
+*> \param[in] N
+*> \verbatim
+*>          N is integer
+*>              Order of the matrix H. N must be either 2 or 3.
+*> \endverbatim
+*>
+*> \param[in] H
+*> \verbatim
+*>          H is COMPLEX array of dimension (LDH,N)
+*>              The 2-by-2 or 3-by-3 matrix H in (*).
+*> \endverbatim
+*>
+*> \param[in] LDH
+*> \verbatim
+*>          LDH is integer
+*>              The leading dimension of H as declared in
+*>              the calling procedure.  LDH.GE.N
+*> \endverbatim
+*>
+*> \param[in] S1
+*> \verbatim
+*>          S1 is COMPLEX
+*> \endverbatim
+*> \verbatim
+*>       S2     S1 and S2 are the shifts defining K in (*) above.
+*> \endverbatim
+*>
+*> \param[out] V
+*> \verbatim
+*>          V is COMPLEX array of dimension N
+*>              A scalar multiple of the first column of the
+*>              matrix K in (*).
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*       LDH    (input) integer
-*              The leading dimension of H as declared in
-*              the calling procedure.  LDH.GE.N
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*       S1     (input) COMPLEX
+*> \date November 2011
 *
-*       S2     S1 and S2 are the shifts defining K in (*) above.
+*> \ingroup complexOTHERauxiliary
 *
-*       V      (output) COMPLEX array of dimension N
-*              A scalar multiple of the first column of the
-*              matrix K in (*).
 *
 *  Further Details
 *  ===============
+*>\details \b Further \b Details
+*> \verbatim
+*>
+*>     Based on contributions by
+*>        Karen Braman and Ralph Byers, Department of Mathematics,
+*>        University of Kansas, USA
+*>
+*> \endverbatim
+*>
+*  =====================================================================
+      SUBROUTINE CLAQR1( N, H, LDH, S1, S2, V )
 *
-*     Based on contributions by
-*        Karen Braman and Ralph Byers, Department of Mathematics,
-*        University of Kansas, USA
+*  -- LAPACK auxiliary routine (version 3.2) --
+*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
+*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
+*     November 2011
+*
+*     .. Scalar Arguments ..
+      COMPLEX            S1, S2
+      INTEGER            LDH, N
+*     ..
+*     .. Array Arguments ..
+      COMPLEX            H( LDH, * ), V( * )
+*     ..
 *
 *  ================================================================
 *