summaryrefslogtreecommitdiff
path: root/SRC/zlarft.f
diff options
context:
space:
mode:
authorjulie <julielangou@users.noreply.github.com>2011-10-31 22:21:11 +0000
committerjulie <julielangou@users.noreply.github.com>2011-10-31 22:21:11 +0000
commit0d9e213c670ab0e68f17d68251412d53250108e1 (patch)
tree2bcab1c08b84e327b9be345385e2c31e8a26905a /SRC/zlarft.f
parent82901cd3e7bb75c73fc3a17fe7bf922289337f97 (diff)
downloadlapack-0d9e213c670ab0e68f17d68251412d53250108e1.tar.gz
lapack-0d9e213c670ab0e68f17d68251412d53250108e1.tar.bz2
lapack-0d9e213c670ab0e68f17d68251412d53250108e1.zip
Correct Warning detected during Doxygen Generation.
Now each routine should have the correct list of arguments. This allowed to detect and fix problems in parameter description of many routines.
Diffstat (limited to 'SRC/zlarft.f')
-rw-r--r--SRC/zlarft.f76
1 files changed, 51 insertions, 25 deletions
diff --git a/SRC/zlarft.f b/SRC/zlarft.f
index 99dc21a1..544e6a9b 100644
--- a/SRC/zlarft.f
+++ b/SRC/zlarft.f
@@ -63,56 +63,82 @@
*> = 'B': H = H(k) . . . H(2) H(1) (Backward)
*> \endverbatim
*>
-*
-* Authors
-* =======
-*
-*> \author Univ. of Tennessee
-*> \author Univ. of California Berkeley
-*> \author Univ. of Colorado Denver
-*> \author NAG Ltd.
-*
-*> \date November 2011
-*
-*> \ingroup complex16OTHERauxiliary
-*
-*
-* Further Details
-* ===============
-*>\details \b Further \b Details
+*> \param[in] STOREV
*> \verbatim
-* reflectors are stored (see also Further Details):
+*> STOREV is CHARACTER*1
+*> Specifies how the vectors which define the elementary
+*> reflectors are stored (see also Further Details):
*> = 'C': columnwise
*> = 'R': rowwise
+*> \endverbatim
*>
-*> N (input) INTEGER
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
*> The order of the block reflector H. N >= 0.
+*> \endverbatim
*>
-*> K (input) INTEGER
+*> \param[in] K
+*> \verbatim
+*> K is INTEGER
*> The order of the triangular factor T (= the number of
*> elementary reflectors). K >= 1.
+*> \endverbatim
*>
-*> V (input/output) COMPLEX*16 array, dimension
+*> \param[in,out] V
+*> \verbatim
+*> V is COMPLEX*16 array, dimension
*> (LDV,K) if STOREV = 'C'
*> (LDV,N) if STOREV = 'R'
*> The matrix V. See further details.
+*> \endverbatim
*>
-*> LDV (input) INTEGER
+*> \param[in] LDV
+*> \verbatim
+*> LDV is INTEGER
*> The leading dimension of the array V.
*> If STOREV = 'C', LDV >= max(1,N); if STOREV = 'R', LDV >= K.
+*> \endverbatim
*>
-*> TAU (input) COMPLEX*16 array, dimension (K)
+*> \param[in] TAU
+*> \verbatim
+*> TAU is COMPLEX*16 array, dimension (K)
*> TAU(i) must contain the scalar factor of the elementary
*> reflector H(i).
+*> \endverbatim
*>
-*> T (output) COMPLEX*16 array, dimension (LDT,K)
+*> \param[out] T
+*> \verbatim
+*> T is COMPLEX*16 array, dimension (LDT,K)
*> The k by k triangular factor T of the block reflector.
*> If DIRECT = 'F', T is upper triangular; if DIRECT = 'B', T is
*> lower triangular. The rest of the array is not used.
+*> \endverbatim
*>
-*> LDT (input) INTEGER
+*> \param[in] LDT
+*> \verbatim
+*> LDT is INTEGER
*> The leading dimension of the array T. LDT >= K.
+*> \endverbatim
*>
+*
+* Authors
+* =======
+*
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
+*
+*> \date November 2011
+*
+*> \ingroup complex16OTHERauxiliary
+*
+*
+* Further Details
+* ===============
+*>\details \b Further \b Details
+*> \verbatim
*>
*> The shape of the matrix V and the storage of the vectors which define
*> the H(i) is best illustrated by the following example with n = 5 and