Integrating Doxygen in comments

1 files changed, 139 insertions, 63 deletions

diff --git a/SRC/slaqp2.f b/SRC/slaqp2.f
index 6e6ab885..c17ccaa5 100644
--- a/SRC/slaqp2.f
+++ b/SRC/slaqp2.f
@@ -1,82 +1,158 @@
-      SUBROUTINE SLAQP2( M, N, OFFSET, A, LDA, JPVT, TAU, VN1, VN2,
-     $                   WORK )
-*
-*  -- LAPACK auxiliary routine (version 3.3.1) --
-*  -- LAPACK is a software package provided by Univ. of Tennessee,    --
-*  -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..--
-*  -- April 2011                                                      --
-*
-*     .. Scalar Arguments ..
-      INTEGER            LDA, M, N, OFFSET
-*     ..
-*     .. Array Arguments ..
-      INTEGER            JPVT( * )
-      REAL               A( LDA, * ), TAU( * ), VN1( * ), VN2( * ),
-     $                   WORK( * )
-*     ..
-*
+*> \brief \b SLAQP2
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE SLAQP2( M, N, OFFSET, A, LDA, JPVT, TAU, VN1, VN2,
+*                          WORK )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            LDA, M, N, OFFSET
+*       ..
+*       .. Array Arguments ..
+*       INTEGER            JPVT( * )
+*       REAL               A( LDA, * ), TAU( * ), VN1( * ), VN2( * ),
+*      $                   WORK( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  SLAQP2 computes a QR factorization with column pivoting of
-*  the block A(OFFSET+1:M,1:N).
-*  The block A(1:OFFSET,1:N) is accordingly pivoted, but not factorized.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> SLAQP2 computes a QR factorization with column pivoting of
+*> the block A(OFFSET+1:M,1:N).
+*> The block A(1:OFFSET,1:N) is accordingly pivoted, but not factorized.
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  M       (input) INTEGER
-*          The number of rows of the matrix A. M >= 0.
-*
-*  N       (input) INTEGER
-*          The number of columns of the matrix A. N >= 0.
-*
-*  OFFSET  (input) INTEGER
-*          The number of rows of the matrix A that must be pivoted
-*          but no factorized. OFFSET >= 0.
-*
-*  A       (input/output) REAL array, dimension (LDA,N)
-*          On entry, the M-by-N matrix A.
-*          On exit, the upper triangle of block A(OFFSET+1:M,1:N) is 
-*          the triangular factor obtained; the elements in block 
-*          A(OFFSET+1:M,1:N) below the diagonal, together with the 
-*          array TAU, represent the orthogonal matrix Q as a product of
-*          elementary reflectors. Block A(1:OFFSET,1:N) has been
-*          accordingly pivoted, but no factorized.
-*
-*  LDA     (input) INTEGER
-*          The leading dimension of the array A. LDA >= max(1,M).
-*
-*  JPVT    (input/output) INTEGER array, dimension (N)
-*          On entry, if JPVT(i) .ne. 0, the i-th column of A is permuted
-*          to the front of A*P (a leading column); if JPVT(i) = 0,
-*          the i-th column of A is a free column.
-*          On exit, if JPVT(i) = k, then the i-th column of A*P
-*          was the k-th column of A.
+*> \param[in] M
+*> \verbatim
+*>          M is INTEGER
+*>          The number of rows of the matrix A. M >= 0.
+*> \endverbatim
+*>
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The number of columns of the matrix A. N >= 0.
+*> \endverbatim
+*>
+*> \param[in] OFFSET
+*> \verbatim
+*>          OFFSET is INTEGER
+*>          The number of rows of the matrix A that must be pivoted
+*>          but no factorized. OFFSET >= 0.
+*> \endverbatim
+*>
+*> \param[in,out] A
+*> \verbatim
+*>          A is REAL array, dimension (LDA,N)
+*>          On entry, the M-by-N matrix A.
+*>          On exit, the upper triangle of block A(OFFSET+1:M,1:N) is 
+*>          the triangular factor obtained; the elements in block 
+*>          A(OFFSET+1:M,1:N) below the diagonal, together with the 
+*>          array TAU, represent the orthogonal matrix Q as a product of
+*>          elementary reflectors. Block A(1:OFFSET,1:N) has been
+*>          accordingly pivoted, but no factorized.
+*> \endverbatim
+*>
+*> \param[in] LDA
+*> \verbatim
+*>          LDA is INTEGER
+*>          The leading dimension of the array A. LDA >= max(1,M).
+*> \endverbatim
+*>
+*> \param[in,out] JPVT
+*> \verbatim
+*>          JPVT is INTEGER array, dimension (N)
+*>          On entry, if JPVT(i) .ne. 0, the i-th column of A is permuted
+*>          to the front of A*P (a leading column); if JPVT(i) = 0,
+*>          the i-th column of A is a free column.
+*>          On exit, if JPVT(i) = k, then the i-th column of A*P
+*>          was the k-th column of A.
+*> \endverbatim
+*>
+*> \param[out] TAU
+*> \verbatim
+*>          TAU is REAL array, dimension (min(M,N))
+*>          The scalar factors of the elementary reflectors.
+*> \endverbatim
+*>
+*> \param[in,out] VN1
+*> \verbatim
+*>          VN1 is REAL array, dimension (N)
+*>          The vector with the partial column norms.
+*> \endverbatim
+*>
+*> \param[in,out] VN2
+*> \verbatim
+*>          VN2 is REAL array, dimension (N)
+*>          The vector with the exact column norms.
+*> \endverbatim
+*>
+*> \param[out] WORK
+*> \verbatim
+*>          WORK is REAL array, dimension (N)
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  TAU     (output) REAL array, dimension (min(M,N))
-*          The scalar factors of the elementary reflectors.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  VN1     (input/output) REAL array, dimension (N)
-*          The vector with the partial column norms.
+*> \date November 2011
 *
-*  VN2     (input/output) REAL array, dimension (N)
-*          The vector with the exact column norms.
+*> \ingroup realOTHERauxiliary
 *
-*  WORK    (workspace) REAL array, dimension (N)
 *
 *  Further Details
 *  ===============
+*>\details \b Further \b Details
+*> \verbatim
+*>
+*>  Based on contributions by
+*>    G. Quintana-Orti, Depto. de Informatica, Universidad Jaime I, Spain
+*>    X. Sun, Computer Science Dept., Duke University, USA
+*>
+*>  Partial column norm updating strategy modified by
+*>    Z. Drmac and Z. Bujanovic, Dept. of Mathematics,
+*>    University of Zagreb, Croatia.
+*>  -- April 2011                                                      --
+*>  For more details see LAPACK Working Note 176.
+*> \endverbatim
+*>
+*  =====================================================================
+      SUBROUTINE SLAQP2( M, N, OFFSET, A, LDA, JPVT, TAU, VN1, VN2,
+     $                   WORK )
+*
+*  -- LAPACK auxiliary routine (version 3.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
 *
-*  Based on contributions by
-*    G. Quintana-Orti, Depto. de Informatica, Universidad Jaime I, Spain
-*    X. Sun, Computer Science Dept., Duke University, USA
+*     .. Scalar Arguments ..
+      INTEGER            LDA, M, N, OFFSET
+*     ..
+*     .. Array Arguments ..
+      INTEGER            JPVT( * )
+      REAL               A( LDA, * ), TAU( * ), VN1( * ), VN2( * ),
+     $                   WORK( * )
+*     ..
 *
-*  Partial column norm updating strategy modified by
-*    Z. Drmac and Z. Bujanovic, Dept. of Mathematics,
-*    University of Zagreb, Croatia.
-*  -- April 2011                                                      --
-*  For more details see LAPACK Working Note 176.
 *  =====================================================================
 *
 *     .. Parameters ..