Integrating Doxygen in comments

1 files changed, 82 insertions, 35 deletions

diff --git a/SRC/slartgp.f b/SRC/slartgp.f
index c4f541be..5f67ef6a 100644
--- a/SRC/slartgp.f
+++ b/SRC/slartgp.f
@@ -1,54 +1,101 @@
-      SUBROUTINE SLARTGP( F, G, CS, SN, R )
+*> \brief \b SLARTGP
 *
-*     Originally SLARTG
-*  -- 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 2006
+*  =========== DOCUMENTATION ===========
 *
-*     Adapted to SLARTGP
-*     July 2010
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
 *
-*     .. Scalar Arguments ..
-      REAL               CS, F, G, R, SN
-*     ..
+*  Definition
+*  ==========
 *
+*       SUBROUTINE SLARTGP( F, G, CS, SN, R )
+* 
+*       .. Scalar Arguments ..
+*       REAL               CS, F, G, R, SN
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  SLARTGP generates a plane rotation so that
-*
-*     [  CS  SN  ]  .  [ F ]  =  [ R ]   where CS**2 + SN**2 = 1.
-*     [ -SN  CS  ]     [ G ]     [ 0 ]
-*
-*  This is a slower, more accurate version of the Level 1 BLAS routine SROTG,
-*  with the following other differences:
-*     F and G are unchanged on return.
-*     If G=0, then CS=(+/-)1 and SN=0.
-*     If F=0 and (G .ne. 0), then CS=0 and SN=(+/-)1.
-*
-*  The sign is chosen so that R >= 0.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> SLARTGP generates a plane rotation so that
+*>
+*>    [  CS  SN  ]  .  [ F ]  =  [ R ]   where CS**2 + SN**2 = 1.
+*>    [ -SN  CS  ]     [ G ]     [ 0 ]
+*>
+*> This is a slower, more accurate version of the Level 1 BLAS routine SROTG,
+*> with the following other differences:
+*>    F and G are unchanged on return.
+*>    If G=0, then CS=(+/-)1 and SN=0.
+*>    If F=0 and (G .ne. 0), then CS=0 and SN=(+/-)1.
+*>
+*> The sign is chosen so that R >= 0.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  F       (input) REAL
-*          The first component of vector to be rotated.
+*> \param[in] F
+*> \verbatim
+*>          F is REAL
+*>          The first component of vector to be rotated.
+*> \endverbatim
+*>
+*> \param[in] G
+*> \verbatim
+*>          G is REAL
+*>          The second component of vector to be rotated.
+*> \endverbatim
+*>
+*> \param[out] CS
+*> \verbatim
+*>          CS is REAL
+*>          The cosine of the rotation.
+*> \endverbatim
+*>
+*> \param[out] SN
+*> \verbatim
+*>          SN is REAL
+*>          The sine of the rotation.
+*> \endverbatim
+*>
+*> \param[out] R
+*> \verbatim
+*>          R is REAL
+*>          The nonzero component of the rotated vector.
+*> \endverbatim
+*> \verbatim
+*>  This version has a few statements commented out for thread safety
+*>  (machine parameters are computed on each entry). 10 feb 03, SJH.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  G       (input) REAL
-*          The second component of vector to be rotated.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  CS      (output) REAL
-*          The cosine of the rotation.
+*> \date November 2011
 *
-*  SN      (output) REAL
-*          The sine of the rotation.
+*> \ingroup auxOTHERauxiliary
 *
-*  R       (output) REAL
-*          The nonzero component of the rotated vector.
+*  =====================================================================
+      SUBROUTINE SLARTGP( F, G, CS, SN, R )
+*
+*  -- 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
 *
-*  This version has a few statements commented out for thread safety
-*  (machine parameters are computed on each entry). 10 feb 03, SJH.
+*     .. Scalar Arguments ..
+      REAL               CS, F, G, R, SN
+*     ..
 *
 *  =====================================================================
 *