diff options
author | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
---|---|---|
committer | julie <julielangou@users.noreply.github.com> | 2011-10-06 06:53:11 +0000 |
commit | e1d39294aee16fa6db9ba079b14442358217db71 (patch) | |
tree | 30e5aa04c1f6596991fda5334f63dfb9b8027849 /SRC/xerbla_array.f | |
parent | 5fe0466a14e395641f4f8a300ecc9dcb8058081b (diff) | |
download | lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.gz lapack-e1d39294aee16fa6db9ba079b14442358217db71.tar.bz2 lapack-e1d39294aee16fa6db9ba079b14442358217db71.zip |
Integrating Doxygen in comments
Diffstat (limited to 'SRC/xerbla_array.f')
-rw-r--r-- | SRC/xerbla_array.f | 120 |
1 files changed, 82 insertions, 38 deletions
diff --git a/SRC/xerbla_array.f b/SRC/xerbla_array.f index ec146cc4..05c4cfec 100644 --- a/SRC/xerbla_array.f +++ b/SRC/xerbla_array.f @@ -1,54 +1,98 @@ - SUBROUTINE XERBLA_ARRAY( SRNAME_ARRAY, SRNAME_LEN, INFO) +*> \brief \b XERBLA_ARRAY * -* -- LAPACK auxiliary routine (version 3.2.2) -- +* =========== DOCUMENTATION =========== * -* -- June 2010 +* Online html documentation available at +* http://www.netlib.org/lapack/explore-html/ * -* -- LAPACK is a software package provided by Univ. of Tennessee, -- -* -- Univ. of California Berkeley, Univ. of Colorado Denver and NAG Ltd..-- -* - IMPLICIT NONE -* .. Scalar Arguments .. - INTEGER SRNAME_LEN, INFO -* .. -* .. Array Arguments .. - CHARACTER(1) SRNAME_ARRAY(SRNAME_LEN) -* .. +* Definition +* ========== * +* SUBROUTINE XERBLA_ARRAY( SRNAME_ARRAY, SRNAME_LEN, INFO) +* +* .. Scalar Arguments .. +* INTEGER SRNAME_LEN, INFO +* .. +* .. Array Arguments .. +* CHARACTER(1) SRNAME_ARRAY(SRNAME_LEN) +* .. +* * Purpose * ======= * -* XERBLA_ARRAY assists other languages in calling XERBLA, the LAPACK -* and BLAS error handler. Rather than taking a Fortran string argument -* as the function's name, XERBLA_ARRAY takes an array of single -* characters along with the array's length. XERBLA_ARRAY then copies -* up to 32 characters of that array into a Fortran string and passes -* that to XERBLA. If called with a non-positive SRNAME_LEN, -* XERBLA_ARRAY will call XERBLA with a string of all blank characters. -* -* Say some macro or other device makes XERBLA_ARRAY available to C99 -* by a name lapack_xerbla and with a common Fortran calling convention. -* Then a C99 program could invoke XERBLA via: -* { -* int flen = strlen(__func__); -* lapack_xerbla(__func__, &flen, &info); -* } -* -* Providing XERBLA_ARRAY is not necessary for intercepting LAPACK -* errors. XERBLA_ARRAY calls XERBLA. +*>\details \b Purpose: +*>\verbatim +*> +*> XERBLA_ARRAY assists other languages in calling XERBLA, the LAPACK +*> and BLAS error handler. Rather than taking a Fortran string argument +*> as the function's name, XERBLA_ARRAY takes an array of single +*> characters along with the array's length. XERBLA_ARRAY then copies +*> up to 32 characters of that array into a Fortran string and passes +*> that to XERBLA. If called with a non-positive SRNAME_LEN, +*> XERBLA_ARRAY will call XERBLA with a string of all blank characters. +*> +*> Say some macro or other device makes XERBLA_ARRAY available to C99 +*> by a name lapack_xerbla and with a common Fortran calling convention. +*> Then a C99 program could invoke XERBLA via: +*> { +*> int flen = strlen(__func__); +*> lapack_xerbla(__func__, &flen, &info); +*> } +*> +*> Providing XERBLA_ARRAY is not necessary for intercepting LAPACK +*> errors. XERBLA_ARRAY calls XERBLA. +*> +*>\endverbatim * * Arguments * ========= * -* SRNAME_ARRAY (input) CHARACTER(1) array, dimension (SRNAME_LEN) -* The name of the routine which called XERBLA_ARRAY. +*> \param[in] SRNAME_ARRAY +*> \verbatim +*> SRNAME_ARRAY is CHARACTER(1) array, dimension (SRNAME_LEN) +*> The name of the routine which called XERBLA_ARRAY. +*> \endverbatim +*> +*> \param[in] SRNAME_LEN +*> \verbatim +*> SRNAME_LEN is INTEGER +*> The length of the name in SRNAME_ARRAY. +*> \endverbatim +*> +*> \param[in] INFO +*> \verbatim +*> INFO is INTEGER +*> The position of the invalid parameter in the parameter list +*> of the calling routine. +*> \endverbatim +*> +* +* Authors +* ======= +* +*> \author Univ. of Tennessee +*> \author Univ. of California Berkeley +*> \author Univ. of Colorado Denver +*> \author NAG Ltd. * -* SRNAME_LEN (input) INTEGER -* The length of the name in SRNAME_ARRAY. +*> \date November 2011 * -* INFO (input) INTEGER -* The position of the invalid parameter in the parameter list -* of the calling routine. +*> \ingroup auxOTHERauxiliary +* +* ===================================================================== + SUBROUTINE XERBLA_ARRAY( SRNAME_ARRAY, SRNAME_LEN, INFO) +* +* -- LAPACK auxiliary routine (version 3.2.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 .. + INTEGER SRNAME_LEN, INFO +* .. +* .. Array Arguments .. + CHARACTER(1) SRNAME_ARRAY(SRNAME_LEN) +* .. * * ===================================================================== * |