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/clar2v.f | 145 ++++++++++++++++++++++++++++++++++++++++++-----------------
 1 file changed, 104 insertions(+), 41 deletions(-)

(limited to 'SRC/clar2v.f')

diff --git a/SRC/clar2v.f b/SRC/clar2v.f
index 3b36a206..eab25210 100644
--- a/SRC/clar2v.f
+++ b/SRC/clar2v.f
@@ -1,57 +1,120 @@
-      SUBROUTINE CLAR2V( N, X, Y, Z, INCX, C, S, INCC )
-*
-*  -- 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
-*
-*     .. Scalar Arguments ..
-      INTEGER            INCC, INCX, N
-*     ..
-*     .. Array Arguments ..
-      REAL               C( * )
-      COMPLEX            S( * ), X( * ), Y( * ), Z( * )
-*     ..
-*
+*> \brief \b CLAR2V
+*
+*  =========== DOCUMENTATION ===========
+*
+* Online html documentation available at 
+*            http://www.netlib.org/lapack/explore-html/ 
+*
+*  Definition
+*  ==========
+*
+*       SUBROUTINE CLAR2V( N, X, Y, Z, INCX, C, S, INCC )
+* 
+*       .. Scalar Arguments ..
+*       INTEGER            INCC, INCX, N
+*       ..
+*       .. Array Arguments ..
+*       REAL               C( * )
+*       COMPLEX            S( * ), X( * ), Y( * ), Z( * )
+*       ..
+*  
 *  Purpose
 *  =======
 *
-*  CLAR2V applies a vector of complex plane rotations with real cosines
-*  from both sides to a sequence of 2-by-2 complex Hermitian matrices,
-*  defined by the elements of the vectors x, y and z. For i = 1,2,...,n
-*
-*     (       x(i)  z(i) ) :=
-*     ( conjg(z(i)) y(i) )
-*
-*       (  c(i) conjg(s(i)) ) (       x(i)  z(i) ) ( c(i) -conjg(s(i)) )
-*       ( -s(i)       c(i)  ) ( conjg(z(i)) y(i) ) ( s(i)        c(i)  )
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> CLAR2V applies a vector of complex plane rotations with real cosines
+*> from both sides to a sequence of 2-by-2 complex Hermitian matrices,
+*> defined by the elements of the vectors x, y and z. For i = 1,2,...,n
+*>
+*>    (       x(i)  z(i) ) :=
+*>    ( conjg(z(i)) y(i) )
+*>
+*>      (  c(i) conjg(s(i)) ) (       x(i)  z(i) ) ( c(i) -conjg(s(i)) )
+*>      ( -s(i)       c(i)  ) ( conjg(z(i)) y(i) ) ( s(i)        c(i)  )
+*>
+*>\endverbatim
 *
 *  Arguments
 *  =========
 *
-*  N       (input) INTEGER
-*          The number of plane rotations to be applied.
-*
-*  X       (input/output) COMPLEX array, dimension (1+(N-1)*INCX)
-*          The vector x; the elements of x are assumed to be real.
+*> \param[in] N
+*> \verbatim
+*>          N is INTEGER
+*>          The number of plane rotations to be applied.
+*> \endverbatim
+*>
+*> \param[in,out] X
+*> \verbatim
+*>          X is COMPLEX array, dimension (1+(N-1)*INCX)
+*>          The vector x; the elements of x are assumed to be real.
+*> \endverbatim
+*>
+*> \param[in,out] Y
+*> \verbatim
+*>          Y is COMPLEX array, dimension (1+(N-1)*INCX)
+*>          The vector y; the elements of y are assumed to be real.
+*> \endverbatim
+*>
+*> \param[in,out] Z
+*> \verbatim
+*>          Z is COMPLEX array, dimension (1+(N-1)*INCX)
+*>          The vector z.
+*> \endverbatim
+*>
+*> \param[in] INCX
+*> \verbatim
+*>          INCX is INTEGER
+*>          The increment between elements of X, Y and Z. INCX > 0.
+*> \endverbatim
+*>
+*> \param[in] C
+*> \verbatim
+*>          C is REAL array, dimension (1+(N-1)*INCC)
+*>          The cosines of the plane rotations.
+*> \endverbatim
+*>
+*> \param[in] S
+*> \verbatim
+*>          S is COMPLEX array, dimension (1+(N-1)*INCC)
+*>          The sines of the plane rotations.
+*> \endverbatim
+*>
+*> \param[in] INCC
+*> \verbatim
+*>          INCC is INTEGER
+*>          The increment between elements of C and S. INCC > 0.
+*> \endverbatim
+*>
+*
+*  Authors
+*  =======
 *
-*  Y       (input/output) COMPLEX array, dimension (1+(N-1)*INCX)
-*          The vector y; the elements of y are assumed to be real.
+*> \author Univ. of Tennessee 
+*> \author Univ. of California Berkeley 
+*> \author Univ. of Colorado Denver 
+*> \author NAG Ltd. 
 *
-*  Z       (input/output) COMPLEX array, dimension (1+(N-1)*INCX)
-*          The vector z.
+*> \date November 2011
 *
-*  INCX    (input) INTEGER
-*          The increment between elements of X, Y and Z. INCX > 0.
+*> \ingroup complexOTHERauxiliary
 *
-*  C       (input) REAL array, dimension (1+(N-1)*INCC)
-*          The cosines of the plane rotations.
+*  =====================================================================
+      SUBROUTINE CLAR2V( N, X, Y, Z, INCX, C, S, INCC )
 *
-*  S       (input) COMPLEX array, dimension (1+(N-1)*INCC)
-*          The sines 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 and S. INCC > 0.
+*     .. Scalar Arguments ..
+      INTEGER            INCC, INCX, N
+*     ..
+*     .. Array Arguments ..
+      REAL               C( * )
+      COMPLEX            S( * ), X( * ), Y( * ), Z( * )
+*     ..
 *
 *  =====================================================================
 *
-- 
cgit v1.2.3