summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHenning Thielemann <git@henning-thielemann.de>2017-06-12 09:41:38 (GMT)
committerHenning Thielemann <git@henning-thielemann.de>2017-06-12 09:41:38 (GMT)
commitbfe60f45713ec225ee565dd9a28bca0c99378511 (patch)
treeebd3e2bfd02e4e00adc587c2745a892549e78517
parentff6637d893261a2248e939db741ed9422f421c72 (diff)
downloadlapack-bfe60f45713ec225ee565dd9a28bca0c99378511.zip
lapack-bfe60f45713ec225ee565dd9a28bca0c99378511.tar.gz
lapack-bfe60f45713ec225ee565dd9a28bca0c99378511.tar.bz2
BLAS/SDSDOT: convert parameter comments to Doxygen format
-rw-r--r--BLAS/SRC/sdsdot.f118
1 files changed, 71 insertions, 47 deletions
diff --git a/BLAS/SRC/sdsdot.f b/BLAS/SRC/sdsdot.f
index 7ee6ad6..f110386 100644
--- a/BLAS/SRC/sdsdot.f
+++ b/BLAS/SRC/sdsdot.f
@@ -18,9 +18,11 @@
* REAL SX(*),SY(*)
* ..
*
-* PURPOSE
-* =======
-*
+*> \par Purpose:
+* =============
+*>
+*> \verbatim
+*>
* Compute the inner product of two vectors with extended
* precision accumulation.
*
@@ -28,56 +30,78 @@
* SDSDOT = SB + sum for I = 0 to N-1 of SX(LX+I*INCX)*SY(LY+I*INCY),
* where LX = 1 if INCX .GE. 0, else LX = 1+(1-N)*INCX, and LY is
* defined in a similar way using INCY.
+*> \endverbatim
*
-* AUTHOR
-* ======
-* Lawson, C. L., (JPL), Hanson, R. J., (SNLA),
-* Kincaid, D. R., (U. of Texas), Krogh, F. T., (JPL)
-*
-* ARGUMENTS
-* =========
-*
-* N (input) INTEGER
-* number of elements in input vector(s)
-*
-* SB (input) REAL
-* single precision scalar to be added to inner product
-*
-* SX (input) REAL array, dimension (N)
-* single precision vector with N elements
-*
-* INCX (input) INTEGER
-* storage spacing between elements of SX
-*
-* SY (input) REAL array, dimension (N)
-* single precision vector with N elements
-*
-* INCY (input) INTEGER
-* storage spacing between elements of SY
-*
-* SDSDOT (output) REAL
-* single precision dot product (SB if N .LE. 0)
+* Arguments:
+* ==========
*
-* Further Details
-* ===============
+*> \param[in] N
+*> \verbatim
+*> N is INTEGER
+*> number of elements in input vector(s)
+*> \endverbatim
+*>
+*> \param[in] SB
+*> \verbatim
+*> SB is REAL
+*> single precision scalar to be added to inner product
+*> \endverbatim
+*>
+*> \param[in] SX
+*> \verbatim
+*> SX is REAL array, dimension ( 1 + ( N - 1 )*abs( INCX ) )
+*> single precision vector with N elements
+*> \endverbatim
+*>
+*> \param[in] INCX
+*> \verbatim
+*> INCX is INTEGER
+*> storage spacing between elements of SX
+*> \endverbatim
+*>
+*> \param[in] SY
+*> \verbatim
+*> SY is REAL array, dimension ( 1 + ( N - 1 )*abs( INCX ) )
+*> single precision vector with N elements
+*> \endverbatim
+*>
+*> \param[in] INCY
+*> \verbatim
+*> INCY is INTEGER
+*> storage spacing between elements of SY
+*> \endverbatim
*
-* REFERENCES
+* Authors:
+* ========
*
-* C. L. Lawson, R. J. Hanson, D. R. Kincaid and F. T.
-* Krogh, Basic linear algebra subprograms for Fortran
-* usage, Algorithm No. 539, Transactions on Mathematical
-* Software 5, 3 (September 1979), pp. 308-323.
+*> \author Lawson, C. L., (JPL), Hanson, R. J., (SNLA),
+*> \author Kincaid, D. R., (U. of Texas), Krogh, F. T., (JPL)
*
-* REVISION HISTORY (YYMMDD)
+*> \ingroup complex_blas_level1
*
-* 791001 DATE WRITTEN
-* 890531 Changed all specific intrinsics to generic. (WRB)
-* 890831 Modified array declarations. (WRB)
-* 890831 REVISION DATE from Version 3.2
-* 891214 Prologue converted to Version 4.0 format. (BAB)
-* 920310 Corrected definition of LX in DESCRIPTION. (WRB)
-* 920501 Reformatted the REFERENCES section. (WRB)
-* 070118 Reformat to LAPACK coding style
+*> \par Further Details:
+* =====================
+*>
+*> \verbatim
+*>
+*> REFERENCES
+*>
+*> C. L. Lawson, R. J. Hanson, D. R. Kincaid and F. T.
+*> Krogh, Basic linear algebra subprograms for Fortran
+*> usage, Algorithm No. 539, Transactions on Mathematical
+*> Software 5, 3 (September 1979), pp. 308-323.
+*>
+*> REVISION HISTORY (YYMMDD)
+*>
+*> 791001 DATE WRITTEN
+*> 890531 Changed all specific intrinsics to generic. (WRB)
+*> 890831 Modified array declarations. (WRB)
+*> 890831 REVISION DATE from Version 3.2
+*> 891214 Prologue converted to Version 4.0 format. (BAB)
+*> 920310 Corrected definition of LX in DESCRIPTION. (WRB)
+*> 920501 Reformatted the REFERENCES section. (WRB)
+*> 070118 Reformat to LAPACK coding style
+*> \endverbatim
*
* =====================================================================
*