From e1d39294aee16fa6db9ba079b14442358217db71 Mon Sep 17 00:00:00 2001
From: julie <julielangou@users.noreply.github.com>
Date: Thu, 6 Oct 2011 06:53:11 +0000
Subject: Integrating Doxygen in comments

---
 SRC/slargv.f | 127 +++++++++++++++++++++++++++++++++++++++++++----------------
 1 file changed, 93 insertions(+), 34 deletions(-)

(limited to 'SRC/slargv.f')

diff --git a/SRC/slargv.f b/SRC/slargv.f
index e1b86413..249a3dd7 100644
--- a/SRC/slargv.f
+++ b/SRC/slargv.f
@@ -1,53 +1,112 @@
-      SUBROUTINE SLARGV( N, X, INCX, Y, INCY, C, INCC )
+*> \brief \b SLARGV
 *
-*  -- 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 ===========
 *
-*     .. Scalar Arguments ..
-      INTEGER            INCC, INCX, INCY, N
-*     ..
-*     .. Array Arguments ..
-      REAL               C( * ), X( * ), Y( * )
-*     ..
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
 *
+*       SUBROUTINE SLARGV( N, X, INCX, Y, INCY, C, INCC )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            INCC, INCX, INCY, N
+*       ..
+*       .. Array Arguments ..
+*       REAL               C( * ), X( * ), Y( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  SLARGV generates a vector of real plane rotations, determined by
-*  elements of the real vectors x and y. For i = 1,2,...,n
-*
-*     (  c(i)  s(i) ) ( x(i) ) = ( a(i) )
-*     ( -s(i)  c(i) ) ( y(i) ) = (   0  )
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> SLARGV generates a vector of real plane rotations, determined by
+*> elements of the real vectors x and y. For i = 1,2,...,n
+*>
+*>    (  c(i)  s(i) ) ( x(i) ) = ( a(i) )
+*>    ( -s(i)  c(i) ) ( y(i) ) = (   0  )
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  N       (input) INTEGER
-*          The number of plane rotations to be generated.
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The number of plane rotations to be generated.
+*> \endverbatim
+*>
+*> \param[in,out] X
+*> \verbatim
+*>          X is REAL array,
+*>                         dimension (1+(N-1)*INCX)
+*>          On entry, the vector x.
+*>          On exit, x(i) is overwritten by a(i), for i = 1,...,n.
+*> \endverbatim
+*>
+*> \param[in] INCX
+*> \verbatim
+*>          INCX is INTEGER
+*>          The increment between elements of X. INCX > 0.
+*> \endverbatim
+*>
+*> \param[in,out] Y
+*> \verbatim
+*>          Y is REAL array,
+*>                         dimension (1+(N-1)*INCY)
+*>          On entry, the vector y.
+*>          On exit, the sines of the plane rotations.
+*> \endverbatim
+*>
+*> \param[in] INCY
+*> \verbatim
+*>          INCY is INTEGER
+*>          The increment between elements of Y. INCY > 0.
+*> \endverbatim
+*>
+*> \param[out] C
+*> \verbatim
+*>          C is REAL array, dimension (1+(N-1)*INCC)
+*>          The cosines of the plane rotations.
+*> \endverbatim
+*>
+*> \param[in] INCC
+*> \verbatim
+*>          INCC is INTEGER
+*>          The increment between elements of C. INCC > 0.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  X       (input/output) REAL array,
-*                         dimension (1+(N-1)*INCX)
-*          On entry, the vector x.
-*          On exit, x(i) is overwritten by a(i), for i = 1,...,n.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  INCX    (input) INTEGER
-*          The increment between elements of X. INCX > 0.
+*> \date November 2011
 *
-*  Y       (input/output) REAL array,
-*                         dimension (1+(N-1)*INCY)
-*          On entry, the vector y.
-*          On exit, the sines of the plane rotations.
+*> \ingroup realOTHERauxiliary
 *
-*  INCY    (input) INTEGER
-*          The increment between elements of Y. INCY > 0.
+*  =====================================================================
+      SUBROUTINE SLARGV( N, X, INCX, Y, INCY, C, INCC )
 *
-*  C       (output) REAL array, dimension (1+(N-1)*INCC)
-*          The cosines of the plane rotations.
+*  -- 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
 *
-*  INCC    (input) INTEGER
-*          The increment between elements of C. INCC > 0.
+*     .. Scalar Arguments ..
+      INTEGER            INCC, INCX, INCY, N
+*     ..
+*     .. Array Arguments ..
+      REAL               C( * ), X( * ), Y( * )
+*     ..
 *
 *  =====================================================================
 *
-- 
cgit v1.2.3