Integrating Doxygen in comments

1 files changed, 140 insertions, 62 deletions

diff --git a/SRC/sggbak.f b/SRC/sggbak.f
index 509a1cae..ca5e3061 100644
--- a/SRC/sggbak.f
+++ b/SRC/sggbak.f
@@ -1,80 +1,158 @@
-      SUBROUTINE SGGBAK( JOB, SIDE, N, ILO, IHI, LSCALE, RSCALE, M, V,
-     $                   LDV, INFO )
-*
-*  -- LAPACK 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
-*
-*     .. Scalar Arguments ..
-      CHARACTER          JOB, SIDE
-      INTEGER            IHI, ILO, INFO, LDV, M, N
-*     ..
-*     .. Array Arguments ..
-      REAL               LSCALE( * ), RSCALE( * ), V( LDV, * )
-*     ..
-*
+*> \brief \b SGGBAK
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE SGGBAK( JOB, SIDE, N, ILO, IHI, LSCALE, RSCALE, M, V,
+*                          LDV, INFO )
+* 
+*       .. Scalar Arguments ..
+*       CHARACTER          JOB, SIDE
+*       INTEGER            IHI, ILO, INFO, LDV, M, N
+*       ..
+*       .. Array Arguments ..
+*       REAL               LSCALE( * ), RSCALE( * ), V( LDV, * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  SGGBAK forms the right or left eigenvectors of a real generalized
-*  eigenvalue problem A*x = lambda*B*x, by backward transformation on
-*  the computed eigenvectors of the balanced pair of matrices output by
-*  SGGBAL.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> SGGBAK forms the right or left eigenvectors of a real generalized
+*> eigenvalue problem A*x = lambda*B*x, by backward transformation on
+*> the computed eigenvectors of the balanced pair of matrices output by
+*> SGGBAL.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  JOB     (input) CHARACTER*1
-*          Specifies the type of backward transformation required:
-*          = 'N':  do nothing, return immediately;
-*          = 'P':  do backward transformation for permutation only;
-*          = 'S':  do backward transformation for scaling only;
-*          = 'B':  do backward transformations for both permutation and
-*                  scaling.
-*          JOB must be the same as the argument JOB supplied to SGGBAL.
-*
-*  SIDE    (input) CHARACTER*1
-*          = 'R':  V contains right eigenvectors;
-*          = 'L':  V contains left eigenvectors.
-*
-*  N       (input) INTEGER
-*          The number of rows of the matrix V.  N >= 0.
-*
-*  ILO     (input) INTEGER
-*
-*  IHI     (input) INTEGER
-*          The integers ILO and IHI determined by SGGBAL.
-*          1 <= ILO <= IHI <= N, if N > 0; ILO=1 and IHI=0, if N=0.
-*
-*  LSCALE  (input) REAL array, dimension (N)
-*          Details of the permutations and/or scaling factors applied
-*          to the left side of A and B, as returned by SGGBAL.
-*
-*  RSCALE  (input) REAL array, dimension (N)
-*          Details of the permutations and/or scaling factors applied
-*          to the right side of A and B, as returned by SGGBAL.
+*> \param[in] JOB
+*> \verbatim
+*>          JOB is CHARACTER*1
+*>          Specifies the type of backward transformation required:
+*>          = 'N':  do nothing, return immediately;
+*>          = 'P':  do backward transformation for permutation only;
+*>          = 'S':  do backward transformation for scaling only;
+*>          = 'B':  do backward transformations for both permutation and
+*>                  scaling.
+*>          JOB must be the same as the argument JOB supplied to SGGBAL.
+*> \endverbatim
+*>
+*> \param[in] SIDE
+*> \verbatim
+*>          SIDE is CHARACTER*1
+*>          = 'R':  V contains right eigenvectors;
+*>          = 'L':  V contains left eigenvectors.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The number of rows of the matrix V.  N >= 0.
+*> \endverbatim
+*>
+*> \param[in] ILO
+*> \verbatim
+*>          ILO is INTEGER
+*> \endverbatim
+*>
+*> \param[in] IHI
+*> \verbatim
+*>          IHI is INTEGER
+*>          The integers ILO and IHI determined by SGGBAL.
+*>          1 <= ILO <= IHI <= N, if N > 0; ILO=1 and IHI=0, if N=0.
+*> \endverbatim
+*>
+*> \param[in] LSCALE
+*> \verbatim
+*>          LSCALE is REAL array, dimension (N)
+*>          Details of the permutations and/or scaling factors applied
+*>          to the left side of A and B, as returned by SGGBAL.
+*> \endverbatim
+*>
+*> \param[in] RSCALE
+*> \verbatim
+*>          RSCALE is REAL array, dimension (N)
+*>          Details of the permutations and/or scaling factors applied
+*>          to the right side of A and B, as returned by SGGBAL.
+*> \endverbatim
+*>
+*> \param[in] M
+*> \verbatim
+*>          M is INTEGER
+*>          The number of columns of the matrix V.  M >= 0.
+*> \endverbatim
+*>
+*> \param[in,out] V
+*> \verbatim
+*>          V is REAL array, dimension (LDV,M)
+*>          On entry, the matrix of right or left eigenvectors to be
+*>          transformed, as returned by STGEVC.
+*>          On exit, V is overwritten by the transformed eigenvectors.
+*> \endverbatim
+*>
+*> \param[in] LDV
+*> \verbatim
+*>          LDV is INTEGER
+*>          The leading dimension of the matrix V. LDV >= max(1,N).
+*> \endverbatim
+*>
+*> \param[out] INFO
+*> \verbatim
+*>          INFO is INTEGER
+*>          = 0:  successful exit.
+*>          < 0:  if INFO = -i, the i-th argument had an illegal value.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  M       (input) INTEGER
-*          The number of columns of the matrix V.  M >= 0.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  V       (input/output) REAL array, dimension (LDV,M)
-*          On entry, the matrix of right or left eigenvectors to be
-*          transformed, as returned by STGEVC.
-*          On exit, V is overwritten by the transformed eigenvectors.
+*> \date November 2011
 *
-*  LDV     (input) INTEGER
-*          The leading dimension of the matrix V. LDV >= max(1,N).
+*> \ingroup realGBcomputational
 *
-*  INFO    (output) INTEGER
-*          = 0:  successful exit.
-*          < 0:  if INFO = -i, the i-th argument had an illegal value.
 *
 *  Further Details
 *  ===============
+*>\details \b Further \b Details
+*> \verbatim
+*>
+*>  See R.C. Ward, Balancing the generalized eigenvalue problem,
+*>                 SIAM J. Sci. Stat. Comp. 2 (1981), 141-152.
+*>
+*> \endverbatim
+*>
+*  =====================================================================
+      SUBROUTINE SGGBAK( JOB, SIDE, N, ILO, IHI, LSCALE, RSCALE, M, V,
+     $                   LDV, INFO )
 *
-*  See R.C. Ward, Balancing the generalized eigenvalue problem,
-*                 SIAM J. Sci. Stat. Comp. 2 (1981), 141-152.
+*  -- LAPACK computational 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 ..
+      CHARACTER          JOB, SIDE
+      INTEGER            IHI, ILO, INFO, LDV, M, N
+*     ..
+*     .. Array Arguments ..
+      REAL               LSCALE( * ), RSCALE( * ), V( LDV, * )
+*     ..
 *
 *  =====================================================================
 *