summaryrefslogtreecommitdiff
path: root/SRC/dlapy3.f
diff options
context:
space:
mode:
authorjulie <julielangou@users.noreply.github.com>2011-10-06 06:53:11 +0000
committerjulie <julielangou@users.noreply.github.com>2011-10-06 06:53:11 +0000
commite1d39294aee16fa6db9ba079b14442358217db71 (patch)
tree30e5aa04c1f6596991fda5334f63dfb9b8027849 /SRC/dlapy3.f
parent5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff)
downloadlapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz
lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2
lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip
Integrating Doxygen in comments
Diffstat (limited to 'SRC/dlapy3.f')
-rw-r--r--SRC/dlapy3.f72
1 files changed, 58 insertions, 14 deletions
diff --git a/SRC/dlapy3.f b/SRC/dlapy3.f
index f4f9fb16..b77022b8 100644
--- a/SRC/dlapy3.f
+++ b/SRC/dlapy3.f
@@ -1,29 +1,73 @@
- DOUBLE PRECISION FUNCTION DLAPY3( X, Y, Z )
+*> \brief \b DLAPY3
*
-* -- 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 ..
- DOUBLE PRECISION X, Y, Z
-* ..
+* Online html documentation available at
+* http://www.netlib.org/lapack/explore-html/
+*
+* Definition
+* ==========
*
+* DOUBLE PRECISION FUNCTION DLAPY3( X, Y, Z )
+*
+* .. Scalar Arguments ..
+* DOUBLE PRECISION X, Y, Z
+* ..
+*
* Purpose
* =======
*
-* DLAPY3 returns sqrt(x**2+y**2+z**2), taking care not to cause
-* unnecessary overflow.
+*>\details \b Purpose:
+*>\verbatim
+*>
+*> DLAPY3 returns sqrt(x**2+y**2+z**2), taking care not to cause
+*> unnecessary overflow.
+*>
+*>\endverbatim
*
* Arguments
* =========
*
-* X (input) DOUBLE PRECISION
+*> \param[in] X
+*> \verbatim
+*> X is DOUBLE PRECISION
+*> \endverbatim
+*>
+*> \param[in] Y
+*> \verbatim
+*> Y is DOUBLE PRECISION
+*> \endverbatim
+*>
+*> \param[in] Z
+*> \verbatim
+*> Z is DOUBLE PRECISION
+*> X, Y and Z specify the values x, y and z.
+*> \endverbatim
+*>
+*
+* Authors
+* =======
+*
+*> \author Univ. of Tennessee
+*> \author Univ. of California Berkeley
+*> \author Univ. of Colorado Denver
+*> \author NAG Ltd.
*
-* Y (input) DOUBLE PRECISION
+*> \date November 2011
*
-* Z (input) DOUBLE PRECISION
-* X, Y and Z specify the values x, y and z.
+*> \ingroup auxOTHERauxiliary
+*
+* =====================================================================
+ DOUBLE PRECISION FUNCTION DLAPY3( X, Y, Z )
+*
+* -- 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
+*
+* .. Scalar Arguments ..
+ DOUBLE PRECISION X, Y, Z
+* ..
*
* =====================================================================
*