diff --git a/BLAS/SRC/caxpy.f b/BLAS/SRC/caxpy.f index 8dfdba9c0a..f50a6bae50 100644 --- a/BLAS/SRC/caxpy.f +++ b/BLAS/SRC/caxpy.f @@ -72,7 +72,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level1 +*> \ingroup axpy * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ccopy.f b/BLAS/SRC/ccopy.f index 1b4999bae6..01ee79aab4 100644 --- a/BLAS/SRC/ccopy.f +++ b/BLAS/SRC/ccopy.f @@ -65,7 +65,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level1 +*> \ingroup copy * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cdotc.f b/BLAS/SRC/cdotc.f index da29fdf896..4f9d8d8d72 100644 --- a/BLAS/SRC/cdotc.f +++ b/BLAS/SRC/cdotc.f @@ -67,7 +67,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level1 +*> \ingroup dot * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cdotu.f b/BLAS/SRC/cdotu.f index d8c21d10c1..a482875f47 100644 --- a/BLAS/SRC/cdotu.f +++ b/BLAS/SRC/cdotu.f @@ -67,7 +67,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level1 +*> \ingroup dot * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cgbmv.f b/BLAS/SRC/cgbmv.f index 49a635d634..9aab2313ab 100644 --- a/BLAS/SRC/cgbmv.f +++ b/BLAS/SRC/cgbmv.f @@ -165,7 +165,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup gbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cgemm.f b/BLAS/SRC/cgemm.f index 7d3d8d8dab..6f1846c748 100644 --- a/BLAS/SRC/cgemm.f +++ b/BLAS/SRC/cgemm.f @@ -166,7 +166,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level3 +*> \ingroup gemm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cgemv.f b/BLAS/SRC/cgemv.f index 574be07602..eb2798682e 100644 --- a/BLAS/SRC/cgemv.f +++ b/BLAS/SRC/cgemv.f @@ -136,7 +136,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup gemv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cgerc.f b/BLAS/SRC/cgerc.f index 716628d8ad..ed6061331f 100644 --- a/BLAS/SRC/cgerc.f +++ b/BLAS/SRC/cgerc.f @@ -109,7 +109,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup ger * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cgeru.f b/BLAS/SRC/cgeru.f index 5ff8f9405d..4802cef117 100644 --- a/BLAS/SRC/cgeru.f +++ b/BLAS/SRC/cgeru.f @@ -109,7 +109,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup ger * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/chbmv.f b/BLAS/SRC/chbmv.f index bddab93259..afa447c8d6 100644 --- a/BLAS/SRC/chbmv.f +++ b/BLAS/SRC/chbmv.f @@ -165,7 +165,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup hbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/chemm.f b/BLAS/SRC/chemm.f index db3826fc67..c9a2c3a0ff 100644 --- a/BLAS/SRC/chemm.f +++ b/BLAS/SRC/chemm.f @@ -170,7 +170,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level3 +*> \ingroup hemm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/chemv.f b/BLAS/SRC/chemv.f index 288ab1436f..2b8866b038 100644 --- a/BLAS/SRC/chemv.f +++ b/BLAS/SRC/chemv.f @@ -132,7 +132,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup hemv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cher.f b/BLAS/SRC/cher.f index 2695a7eb1b..9bec62166c 100644 --- a/BLAS/SRC/cher.f +++ b/BLAS/SRC/cher.f @@ -114,7 +114,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup her * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cher2.f b/BLAS/SRC/cher2.f index 68976b46ee..025c2e5b99 100644 --- a/BLAS/SRC/cher2.f +++ b/BLAS/SRC/cher2.f @@ -129,7 +129,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup her2 * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cher2k.f b/BLAS/SRC/cher2k.f index a77908738a..1d9910c493 100644 --- a/BLAS/SRC/cher2k.f +++ b/BLAS/SRC/cher2k.f @@ -173,7 +173,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level3 +*> \ingroup her2k * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cherk.f b/BLAS/SRC/cherk.f index 4b229c2382..01b5d4e37e 100644 --- a/BLAS/SRC/cherk.f +++ b/BLAS/SRC/cherk.f @@ -149,7 +149,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level3 +*> \ingroup herk * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/chpmv.f b/BLAS/SRC/chpmv.f index 459a9ba3ed..e8b42d69d8 100644 --- a/BLAS/SRC/chpmv.f +++ b/BLAS/SRC/chpmv.f @@ -127,7 +127,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup hpmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/chpr.f b/BLAS/SRC/chpr.f index 62a946f242..a5b378830d 100644 --- a/BLAS/SRC/chpr.f +++ b/BLAS/SRC/chpr.f @@ -109,7 +109,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup hpr * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/chpr2.f b/BLAS/SRC/chpr2.f index cb07168b0e..a16f08a2a2 100644 --- a/BLAS/SRC/chpr2.f +++ b/BLAS/SRC/chpr2.f @@ -124,7 +124,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup hpr2 * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/crotg.f90 b/BLAS/SRC/crotg.f90 index 8704196408..d16c6af905 100644 --- a/BLAS/SRC/crotg.f90 +++ b/BLAS/SRC/crotg.f90 @@ -5,19 +5,16 @@ ! Online html documentation available at ! http://www.netlib.org/lapack/explore-html/ ! -! Definition: -! =========== -! -! CROTG constructs a plane rotation -! [ c s ] [ a ] = [ r ] -! [ -conjg(s) c ] [ b ] [ 0 ] -! where c is real, s is complex, and c**2 + conjg(s)*s = 1. -! !> \par Purpose: ! ============= !> !> \verbatim !> +!> CROTG constructs a plane rotation +!> [ c s ] [ a ] = [ r ] +!> [ -conjg(s) c ] [ b ] [ 0 ] +!> where c is real, s is complex, and c**2 + conjg(s)*s = 1. +!> !> The computation uses the formulas !> |x| = sqrt( Re(x)**2 + Im(x)**2 ) !> sgn(x) = x / |x| if x /= 0 @@ -33,6 +30,8 @@ !> if the signs of a and b are not the same. !> !> \endverbatim +!> +!> @see lartg, @see lartgp ! ! Arguments: ! ========== @@ -69,7 +68,7 @@ ! !> \date December 2021 ! -!> \ingroup single_blas_level1 +!> \ingroup rotg ! !> \par Further Details: ! ===================== @@ -181,7 +180,7 @@ subroutine CROTG( a, b, c, s ) f2 = ABSSQ( f ) g2 = ABSSQ( g ) h2 = f2 + g2 - ! safmin <= f2 <= h2 <= safmax + ! safmin <= f2 <= h2 <= safmax if( f2 >= h2 * safmin ) then ! safmin <= f2/h2 <= 1, and h2/f2 is finite c = sqrt( f2 / h2 ) @@ -237,7 +236,7 @@ subroutine CROTG( a, b, c, s ) f2 = ABSSQ( fs ) h2 = f2 + g2 end if - ! safmin <= f2 <= h2 <= safmax + ! safmin <= f2 <= h2 <= safmax if( f2 >= h2 * safmin ) then ! safmin <= f2/h2 <= 1, and h2/f2 is finite c = sqrt( f2 / h2 ) diff --git a/BLAS/SRC/cscal.f b/BLAS/SRC/cscal.f index 411098835c..0fbfb72b4a 100644 --- a/BLAS/SRC/cscal.f +++ b/BLAS/SRC/cscal.f @@ -61,7 +61,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level1 +*> \ingroup scal * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/csrot.f b/BLAS/SRC/csrot.f index 2b4b92b722..45f62c2d2d 100644 --- a/BLAS/SRC/csrot.f +++ b/BLAS/SRC/csrot.f @@ -91,7 +91,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level1 +*> \ingroup rot * * ===================================================================== SUBROUTINE CSROT( N, CX, INCX, CY, INCY, C, S ) diff --git a/BLAS/SRC/csscal.f b/BLAS/SRC/csscal.f index b9a8ca5522..45702c5afa 100644 --- a/BLAS/SRC/csscal.f +++ b/BLAS/SRC/csscal.f @@ -61,7 +61,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level1 +*> \ingroup scal * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/cswap.f b/BLAS/SRC/cswap.f index 310bf18178..9962431c9c 100644 --- a/BLAS/SRC/cswap.f +++ b/BLAS/SRC/cswap.f @@ -65,7 +65,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level1 +*> \ingroup swap * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/csymm.f b/BLAS/SRC/csymm.f index 831bdef693..9a7b360009 100644 --- a/BLAS/SRC/csymm.f +++ b/BLAS/SRC/csymm.f @@ -168,7 +168,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level3 +*> \ingroup hemm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/csyr2k.f b/BLAS/SRC/csyr2k.f index 09751895d2..5354c39b5b 100644 --- a/BLAS/SRC/csyr2k.f +++ b/BLAS/SRC/csyr2k.f @@ -167,7 +167,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level3 +*> \ingroup her2k * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/csyrk.f b/BLAS/SRC/csyrk.f index 97bde056cd..b6ff32da4e 100644 --- a/BLAS/SRC/csyrk.f +++ b/BLAS/SRC/csyrk.f @@ -146,7 +146,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level3 +*> \ingroup herk * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ctbmv.f b/BLAS/SRC/ctbmv.f index cc07f6c32b..2008d839f1 100644 --- a/BLAS/SRC/ctbmv.f +++ b/BLAS/SRC/ctbmv.f @@ -164,7 +164,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup tbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ctbsv.f b/BLAS/SRC/ctbsv.f index f1f7076174..25592412cb 100644 --- a/BLAS/SRC/ctbsv.f +++ b/BLAS/SRC/ctbsv.f @@ -168,7 +168,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup tbsv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ctpmv.f b/BLAS/SRC/ctpmv.f index 1a37753c69..318738611c 100644 --- a/BLAS/SRC/ctpmv.f +++ b/BLAS/SRC/ctpmv.f @@ -120,7 +120,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup tpmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ctpsv.f b/BLAS/SRC/ctpsv.f index b5cab53a88..c7ba280af4 100644 --- a/BLAS/SRC/ctpsv.f +++ b/BLAS/SRC/ctpsv.f @@ -123,7 +123,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup tpsv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ctrmm.f b/BLAS/SRC/ctrmm.f index a015fe990d..c4c3b9a926 100644 --- a/BLAS/SRC/ctrmm.f +++ b/BLAS/SRC/ctrmm.f @@ -156,7 +156,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level3 +*> \ingroup trmm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ctrmv.f b/BLAS/SRC/ctrmv.f index 1c312946f8..52ec618daf 100644 --- a/BLAS/SRC/ctrmv.f +++ b/BLAS/SRC/ctrmv.f @@ -125,7 +125,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup trmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ctrsm.f b/BLAS/SRC/ctrsm.f index b59a831ce9..eff616343d 100644 --- a/BLAS/SRC/ctrsm.f +++ b/BLAS/SRC/ctrsm.f @@ -159,7 +159,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level3 +*> \ingroup trsm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ctrsv.f b/BLAS/SRC/ctrsv.f index 77704c9637..3e80e442e8 100644 --- a/BLAS/SRC/ctrsv.f +++ b/BLAS/SRC/ctrsv.f @@ -128,7 +128,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex_blas_level2 +*> \ingroup trsv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dasum.f b/BLAS/SRC/dasum.f index 9a360b5acd..7a1c208c5c 100644 --- a/BLAS/SRC/dasum.f +++ b/BLAS/SRC/dasum.f @@ -54,7 +54,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup asum * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/daxpy.f b/BLAS/SRC/daxpy.f index 421f7c630b..1a6dab447d 100644 --- a/BLAS/SRC/daxpy.f +++ b/BLAS/SRC/daxpy.f @@ -73,7 +73,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup axpy * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dcabs1.f b/BLAS/SRC/dcabs1.f index f6212a8595..6505ffc61e 100644 --- a/BLAS/SRC/dcabs1.f +++ b/BLAS/SRC/dcabs1.f @@ -40,7 +40,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup abs1 * * ===================================================================== DOUBLE PRECISION FUNCTION DCABS1(Z) diff --git a/BLAS/SRC/dcopy.f b/BLAS/SRC/dcopy.f index ded46c5ecf..1bf4fd2d09 100644 --- a/BLAS/SRC/dcopy.f +++ b/BLAS/SRC/dcopy.f @@ -66,7 +66,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup copy * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ddot.f b/BLAS/SRC/ddot.f index 683a04bd46..4f85fcd786 100644 --- a/BLAS/SRC/ddot.f +++ b/BLAS/SRC/ddot.f @@ -66,7 +66,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup dot * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dgbmv.f b/BLAS/SRC/dgbmv.f index d31ea24ca9..64a1728b16 100644 --- a/BLAS/SRC/dgbmv.f +++ b/BLAS/SRC/dgbmv.f @@ -163,7 +163,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup gbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dgemm.f b/BLAS/SRC/dgemm.f index 6814603357..1484b1900c 100644 --- a/BLAS/SRC/dgemm.f +++ b/BLAS/SRC/dgemm.f @@ -166,7 +166,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level3 +*> \ingroup gemm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dgemv.f b/BLAS/SRC/dgemv.f index 6625509b3a..b330da5d0e 100644 --- a/BLAS/SRC/dgemv.f +++ b/BLAS/SRC/dgemv.f @@ -134,7 +134,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup gemv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dger.f b/BLAS/SRC/dger.f index 8c19cb4e41..32bfc0d9b2 100644 --- a/BLAS/SRC/dger.f +++ b/BLAS/SRC/dger.f @@ -109,7 +109,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup ger * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dnrm2.f90 b/BLAS/SRC/dnrm2.f90 index 06f7917cf0..fac9e21b7c 100644 --- a/BLAS/SRC/dnrm2.f90 +++ b/BLAS/SRC/dnrm2.f90 @@ -60,7 +60,7 @@ ! !> \date August 2016 ! -!> \ingroup single_blas_level1 +!> \ingroup nrm2 ! !> \par Contributors: ! ================== diff --git a/BLAS/SRC/drot.f b/BLAS/SRC/drot.f index 0386626c8f..e50e151275 100644 --- a/BLAS/SRC/drot.f +++ b/BLAS/SRC/drot.f @@ -76,7 +76,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup rot * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/drotg.f90 b/BLAS/SRC/drotg.f90 index a344cd4856..fa1f7c02ef 100644 --- a/BLAS/SRC/drotg.f90 +++ b/BLAS/SRC/drotg.f90 @@ -5,19 +5,16 @@ ! Online html documentation available at ! http://www.netlib.org/lapack/explore-html/ ! -! Definition: -! =========== -! -! DROTG constructs a plane rotation -! [ c s ] [ a ] = [ r ] -! [ -s c ] [ b ] [ 0 ] -! satisfying c**2 + s**2 = 1. -! !> \par Purpose: ! ============= !> !> \verbatim !> +!> DROTG constructs a plane rotation +!> [ c s ] [ a ] = [ r ] +!> [ -s c ] [ b ] [ 0 ] +!> satisfying c**2 + s**2 = 1. +!> !> The computation uses the formulas !> sigma = sgn(a) if |a| > |b| !> = sgn(b) if |b| >= |a| @@ -34,6 +31,8 @@ !> If |z| > 1, set c = 1/z and s = sqrt( 1 - c**2). !> !> \endverbatim +!> +!> @see lartg, @see lartgp ! ! Arguments: ! ========== @@ -74,7 +73,7 @@ !> !> Weslley Pereira, University of Colorado Denver, USA ! -!> \ingroup single_blas_level1 +!> \ingroup rotg ! !> \par Further Details: ! ===================== diff --git a/BLAS/SRC/drotm.f b/BLAS/SRC/drotm.f index 0363ddd888..450510d143 100644 --- a/BLAS/SRC/drotm.f +++ b/BLAS/SRC/drotm.f @@ -89,7 +89,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup rotm * * ===================================================================== SUBROUTINE DROTM(N,DX,INCX,DY,INCY,DPARAM) diff --git a/BLAS/SRC/drotmg.f b/BLAS/SRC/drotmg.f index be59f314a6..920734ae7b 100644 --- a/BLAS/SRC/drotmg.f +++ b/BLAS/SRC/drotmg.f @@ -83,7 +83,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup rotmg * * ===================================================================== SUBROUTINE DROTMG(DD1,DD2,DX1,DY1,DPARAM) diff --git a/BLAS/SRC/dsbmv.f b/BLAS/SRC/dsbmv.f index ad9e418a1e..fdf20620b8 100644 --- a/BLAS/SRC/dsbmv.f +++ b/BLAS/SRC/dsbmv.f @@ -162,7 +162,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup hbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dscal.f b/BLAS/SRC/dscal.f index e055d198af..625afba92a 100644 --- a/BLAS/SRC/dscal.f +++ b/BLAS/SRC/dscal.f @@ -62,7 +62,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup scal * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dsdot.f b/BLAS/SRC/dsdot.f index ae254a6e50..fcfa1aa7b1 100644 --- a/BLAS/SRC/dsdot.f +++ b/BLAS/SRC/dsdot.f @@ -84,7 +84,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup dot * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dspmv.f b/BLAS/SRC/dspmv.f index a79c74da7b..518ab77a2b 100644 --- a/BLAS/SRC/dspmv.f +++ b/BLAS/SRC/dspmv.f @@ -125,7 +125,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup hpmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dspr.f b/BLAS/SRC/dspr.f index 67227a2d58..2bc025ec51 100644 --- a/BLAS/SRC/dspr.f +++ b/BLAS/SRC/dspr.f @@ -106,7 +106,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup hpr * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dspr2.f b/BLAS/SRC/dspr2.f index 0756c2bbd6..32c9cd50cf 100644 --- a/BLAS/SRC/dspr2.f +++ b/BLAS/SRC/dspr2.f @@ -121,7 +121,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup hpr2 * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dswap.f b/BLAS/SRC/dswap.f index b7600aa2d4..ae85389db5 100644 --- a/BLAS/SRC/dswap.f +++ b/BLAS/SRC/dswap.f @@ -66,7 +66,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup swap * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dsymm.f b/BLAS/SRC/dsymm.f index 0ddffec7b7..8027389c86 100644 --- a/BLAS/SRC/dsymm.f +++ b/BLAS/SRC/dsymm.f @@ -168,7 +168,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level3 +*> \ingroup hemm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dsymv.f b/BLAS/SRC/dsymv.f index 17310d7c62..ebd6e9e3e4 100644 --- a/BLAS/SRC/dsymv.f +++ b/BLAS/SRC/dsymv.f @@ -130,7 +130,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup hemv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dsyr.f b/BLAS/SRC/dsyr.f index ab452dd950..dd722c417a 100644 --- a/BLAS/SRC/dsyr.f +++ b/BLAS/SRC/dsyr.f @@ -111,7 +111,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup her * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dsyr2.f b/BLAS/SRC/dsyr2.f index 4bad19b96b..93616ff7eb 100644 --- a/BLAS/SRC/dsyr2.f +++ b/BLAS/SRC/dsyr2.f @@ -126,7 +126,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup her2 * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dsyr2k.f b/BLAS/SRC/dsyr2k.f index f5d16e0854..54e4ea721d 100644 --- a/BLAS/SRC/dsyr2k.f +++ b/BLAS/SRC/dsyr2k.f @@ -170,7 +170,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level3 +*> \ingroup her2k * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dsyrk.f b/BLAS/SRC/dsyrk.f index 0548c0ce2f..b62fb6d128 100644 --- a/BLAS/SRC/dsyrk.f +++ b/BLAS/SRC/dsyrk.f @@ -148,7 +148,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level3 +*> \ingroup herk * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dtbmv.f b/BLAS/SRC/dtbmv.f index 443415e05e..cdf1e8b075 100644 --- a/BLAS/SRC/dtbmv.f +++ b/BLAS/SRC/dtbmv.f @@ -164,7 +164,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup tbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dtbsv.f b/BLAS/SRC/dtbsv.f index 002ed590a8..683a5eb08d 100644 --- a/BLAS/SRC/dtbsv.f +++ b/BLAS/SRC/dtbsv.f @@ -168,7 +168,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup tbsv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dtpmv.f b/BLAS/SRC/dtpmv.f index 48b3035551..a45bf9823e 100644 --- a/BLAS/SRC/dtpmv.f +++ b/BLAS/SRC/dtpmv.f @@ -120,7 +120,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup tpmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dtpsv.f b/BLAS/SRC/dtpsv.f index 3246ac21dd..72bbb88e29 100644 --- a/BLAS/SRC/dtpsv.f +++ b/BLAS/SRC/dtpsv.f @@ -123,7 +123,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup tpsv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dtrmm.f b/BLAS/SRC/dtrmm.f index 16b1d48e25..2424ca821e 100644 --- a/BLAS/SRC/dtrmm.f +++ b/BLAS/SRC/dtrmm.f @@ -156,7 +156,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level3 +*> \ingroup trmm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dtrmv.f b/BLAS/SRC/dtrmv.f index 3ecd67ae25..48f2b44450 100644 --- a/BLAS/SRC/dtrmv.f +++ b/BLAS/SRC/dtrmv.f @@ -125,7 +125,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level2 +*> \ingroup trmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dtrsm.f b/BLAS/SRC/dtrsm.f index 53bac55b4a..44b91f4bac 100644 --- a/BLAS/SRC/dtrsm.f +++ b/BLAS/SRC/dtrsm.f @@ -159,7 +159,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level3 +*> \ingroup trsm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dtrsv.f b/BLAS/SRC/dtrsv.f index bf1e760c1b..ce5759b68a 100644 --- a/BLAS/SRC/dtrsv.f +++ b/BLAS/SRC/dtrsv.f @@ -136,7 +136,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup trsv * * ===================================================================== SUBROUTINE DTRSV(UPLO,TRANS,DIAG,N,A,LDA,X,INCX) diff --git a/BLAS/SRC/dzasum.f b/BLAS/SRC/dzasum.f index 7cc6ec506a..98f45b06f4 100644 --- a/BLAS/SRC/dzasum.f +++ b/BLAS/SRC/dzasum.f @@ -55,7 +55,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup double_blas_level1 +*> \ingroup asum * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/dznrm2.f90 b/BLAS/SRC/dznrm2.f90 index 0ca3c75c52..513cbdb18b 100644 --- a/BLAS/SRC/dznrm2.f90 +++ b/BLAS/SRC/dznrm2.f90 @@ -61,7 +61,7 @@ ! !> \date August 2016 ! -!> \ingroup single_blas_level1 +!> \ingroup nrm2 ! !> \par Contributors: ! ================== diff --git a/BLAS/SRC/icamax.f b/BLAS/SRC/icamax.f index c103cc800e..b65cbf8cf3 100644 --- a/BLAS/SRC/icamax.f +++ b/BLAS/SRC/icamax.f @@ -54,7 +54,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup aux_blas +*> \ingroup iamax * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/idamax.f b/BLAS/SRC/idamax.f index 1be301ea3e..06d7d7ee80 100644 --- a/BLAS/SRC/idamax.f +++ b/BLAS/SRC/idamax.f @@ -54,7 +54,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup aux_blas +*> \ingroup iamax * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/isamax.f b/BLAS/SRC/isamax.f index 8ad44ad419..91e8f27537 100644 --- a/BLAS/SRC/isamax.f +++ b/BLAS/SRC/isamax.f @@ -54,7 +54,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup aux_blas +*> \ingroup iamax * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/izamax.f b/BLAS/SRC/izamax.f index e4779a1ff2..0fe4125070 100644 --- a/BLAS/SRC/izamax.f +++ b/BLAS/SRC/izamax.f @@ -54,7 +54,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup aux_blas +*> \ingroup iamax * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/lsame.f b/BLAS/SRC/lsame.f index 6aa4007065..eef9ee513d 100644 --- a/BLAS/SRC/lsame.f +++ b/BLAS/SRC/lsame.f @@ -46,7 +46,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup aux_blas +*> \ingroup lsame * * ===================================================================== LOGICAL FUNCTION LSAME(CA,CB) diff --git a/BLAS/SRC/sasum.f b/BLAS/SRC/sasum.f index 6c2e0c9bc8..95e99b3ab9 100644 --- a/BLAS/SRC/sasum.f +++ b/BLAS/SRC/sasum.f @@ -55,7 +55,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup asum * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/saxpy.f b/BLAS/SRC/saxpy.f index ded238a9f9..f33a35875b 100644 --- a/BLAS/SRC/saxpy.f +++ b/BLAS/SRC/saxpy.f @@ -73,7 +73,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup axpy * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/scabs1.f b/BLAS/SRC/scabs1.f index 9bacf09db6..6fed4267be 100644 --- a/BLAS/SRC/scabs1.f +++ b/BLAS/SRC/scabs1.f @@ -39,7 +39,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup abs1 * * ===================================================================== REAL FUNCTION SCABS1(Z) diff --git a/BLAS/SRC/scasum.f b/BLAS/SRC/scasum.f index 8fd67e9b29..a562746ae2 100644 --- a/BLAS/SRC/scasum.f +++ b/BLAS/SRC/scasum.f @@ -55,7 +55,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup asum * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/scnrm2.f90 b/BLAS/SRC/scnrm2.f90 index 1c2b2d42a8..6729933487 100644 --- a/BLAS/SRC/scnrm2.f90 +++ b/BLAS/SRC/scnrm2.f90 @@ -61,7 +61,7 @@ ! !> \date August 2016 ! -!> \ingroup single_blas_level1 +!> \ingroup nrm2 ! !> \par Contributors: ! ================== diff --git a/BLAS/SRC/scopy.f b/BLAS/SRC/scopy.f index 961025ca44..29e0c74e11 100644 --- a/BLAS/SRC/scopy.f +++ b/BLAS/SRC/scopy.f @@ -66,7 +66,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup copy * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/sdot.f b/BLAS/SRC/sdot.f index ed7213e4a9..da8574c07e 100644 --- a/BLAS/SRC/sdot.f +++ b/BLAS/SRC/sdot.f @@ -66,7 +66,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup dot * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/sdsdot.f b/BLAS/SRC/sdsdot.f index f70fee7974..329a716dda 100644 --- a/BLAS/SRC/sdsdot.f +++ b/BLAS/SRC/sdsdot.f @@ -82,7 +82,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup dot * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/sgbmv.f b/BLAS/SRC/sgbmv.f index a79a833f7e..07deaca2f0 100644 --- a/BLAS/SRC/sgbmv.f +++ b/BLAS/SRC/sgbmv.f @@ -163,7 +163,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup gbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/sgemm.f b/BLAS/SRC/sgemm.f index 0757ee4859..3e31add9fa 100644 --- a/BLAS/SRC/sgemm.f +++ b/BLAS/SRC/sgemm.f @@ -166,7 +166,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level3 +*> \ingroup gemm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/sgemv.f b/BLAS/SRC/sgemv.f index 0517b124c5..aafcdff0b5 100644 --- a/BLAS/SRC/sgemv.f +++ b/BLAS/SRC/sgemv.f @@ -134,7 +134,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup gemv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/sger.f b/BLAS/SRC/sger.f index 9dfe4a2826..1b8aceaf23 100644 --- a/BLAS/SRC/sger.f +++ b/BLAS/SRC/sger.f @@ -109,7 +109,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup ger * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/snrm2.f90 b/BLAS/SRC/snrm2.f90 index 1ea1a473fc..70dc48b248 100644 --- a/BLAS/SRC/snrm2.f90 +++ b/BLAS/SRC/snrm2.f90 @@ -60,7 +60,7 @@ ! !> \date August 2016 ! -!> \ingroup single_blas_level1 +!> \ingroup nrm2 ! !> \par Contributors: ! ================== diff --git a/BLAS/SRC/srot.f b/BLAS/SRC/srot.f index 1441e0d939..ab7bc1efff 100644 --- a/BLAS/SRC/srot.f +++ b/BLAS/SRC/srot.f @@ -76,7 +76,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup rot * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/srotg.f90 b/BLAS/SRC/srotg.f90 index af1beceeef..ce536a5bea 100644 --- a/BLAS/SRC/srotg.f90 +++ b/BLAS/SRC/srotg.f90 @@ -5,19 +5,16 @@ ! Online html documentation available at ! http://www.netlib.org/lapack/explore-html/ ! -! Definition: -! =========== -! -! SROTG constructs a plane rotation -! [ c s ] [ a ] = [ r ] -! [ -s c ] [ b ] [ 0 ] -! satisfying c**2 + s**2 = 1. -! !> \par Purpose: ! ============= !> !> \verbatim !> +!> SROTG constructs a plane rotation +!> [ c s ] [ a ] = [ r ] +!> [ -s c ] [ b ] [ 0 ] +!> satisfying c**2 + s**2 = 1. +!> !> The computation uses the formulas !> sigma = sgn(a) if |a| > |b| !> = sgn(b) if |b| >= |a| @@ -34,6 +31,8 @@ !> If |z| > 1, set c = 1/z and s = sqrt( 1 - c**2). !> !> \endverbatim +!> +!> @see lartg, @see lartgp ! ! Arguments: ! ========== @@ -74,7 +73,7 @@ !> !> Weslley Pereira, University of Colorado Denver, USA ! -!> \ingroup single_blas_level1 +!> \ingroup rotg ! !> \par Further Details: ! ===================== diff --git a/BLAS/SRC/srotm.f b/BLAS/SRC/srotm.f index a20cfd9649..a25519b465 100644 --- a/BLAS/SRC/srotm.f +++ b/BLAS/SRC/srotm.f @@ -90,7 +90,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup rotm * * ===================================================================== SUBROUTINE SROTM(N,SX,INCX,SY,INCY,SPARAM) diff --git a/BLAS/SRC/srotmg.f b/BLAS/SRC/srotmg.f index 63d55dde03..9273927d45 100644 --- a/BLAS/SRC/srotmg.f +++ b/BLAS/SRC/srotmg.f @@ -83,7 +83,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup rotmg * * ===================================================================== SUBROUTINE SROTMG(SD1,SD2,SX1,SY1,SPARAM) diff --git a/BLAS/SRC/ssbmv.f b/BLAS/SRC/ssbmv.f index c458131709..c2a0b3eb60 100644 --- a/BLAS/SRC/ssbmv.f +++ b/BLAS/SRC/ssbmv.f @@ -162,7 +162,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup hbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/sscal.f b/BLAS/SRC/sscal.f index 44d0437968..b535f222bf 100644 --- a/BLAS/SRC/sscal.f +++ b/BLAS/SRC/sscal.f @@ -62,7 +62,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup scal * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/sspmv.f b/BLAS/SRC/sspmv.f index 840fd5c79a..4ca5e3e529 100644 --- a/BLAS/SRC/sspmv.f +++ b/BLAS/SRC/sspmv.f @@ -125,7 +125,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup hpmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/sspr.f b/BLAS/SRC/sspr.f index ab24d3f1dc..f57364956a 100644 --- a/BLAS/SRC/sspr.f +++ b/BLAS/SRC/sspr.f @@ -106,7 +106,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup hpr * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/sspr2.f b/BLAS/SRC/sspr2.f index 1107a8c655..a51ed32ba4 100644 --- a/BLAS/SRC/sspr2.f +++ b/BLAS/SRC/sspr2.f @@ -121,7 +121,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup hpr2 * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/sswap.f b/BLAS/SRC/sswap.f index 1a0fd9a025..57af902b78 100644 --- a/BLAS/SRC/sswap.f +++ b/BLAS/SRC/sswap.f @@ -66,7 +66,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level1 +*> \ingroup swap * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ssymm.f b/BLAS/SRC/ssymm.f index bfa8d16336..4174fa6e4a 100644 --- a/BLAS/SRC/ssymm.f +++ b/BLAS/SRC/ssymm.f @@ -168,7 +168,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level3 +*> \ingroup hemm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ssymv.f b/BLAS/SRC/ssymv.f index 91117989bf..4a15c24837 100644 --- a/BLAS/SRC/ssymv.f +++ b/BLAS/SRC/ssymv.f @@ -130,7 +130,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup hemv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ssyr.f b/BLAS/SRC/ssyr.f index 51164c5c41..0588966ddb 100644 --- a/BLAS/SRC/ssyr.f +++ b/BLAS/SRC/ssyr.f @@ -111,7 +111,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup her * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ssyr2.f b/BLAS/SRC/ssyr2.f index 1dc73eee96..2593986459 100644 --- a/BLAS/SRC/ssyr2.f +++ b/BLAS/SRC/ssyr2.f @@ -126,7 +126,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup her2 * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ssyr2k.f b/BLAS/SRC/ssyr2k.f index 1bb5aa4caf..027927a0c3 100644 --- a/BLAS/SRC/ssyr2k.f +++ b/BLAS/SRC/ssyr2k.f @@ -170,7 +170,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level3 +*> \ingroup her2k * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ssyrk.f b/BLAS/SRC/ssyrk.f index faca01b894..d1dcd124c6 100644 --- a/BLAS/SRC/ssyrk.f +++ b/BLAS/SRC/ssyrk.f @@ -148,7 +148,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level3 +*> \ingroup herk * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/stbmv.f b/BLAS/SRC/stbmv.f index 31c8dcb5f9..1af11e4fff 100644 --- a/BLAS/SRC/stbmv.f +++ b/BLAS/SRC/stbmv.f @@ -164,7 +164,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup tbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/stbsv.f b/BLAS/SRC/stbsv.f index 8f9aeef6c7..24d1105243 100644 --- a/BLAS/SRC/stbsv.f +++ b/BLAS/SRC/stbsv.f @@ -168,7 +168,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup tbsv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/stpmv.f b/BLAS/SRC/stpmv.f index d56e90b312..b36ecd3cdc 100644 --- a/BLAS/SRC/stpmv.f +++ b/BLAS/SRC/stpmv.f @@ -120,7 +120,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup tpmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/stpsv.f b/BLAS/SRC/stpsv.f index 2c91d626e4..b409964c3e 100644 --- a/BLAS/SRC/stpsv.f +++ b/BLAS/SRC/stpsv.f @@ -123,7 +123,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup tpsv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/strmm.f b/BLAS/SRC/strmm.f index e353e28df4..113999835d 100644 --- a/BLAS/SRC/strmm.f +++ b/BLAS/SRC/strmm.f @@ -156,7 +156,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level3 +*> \ingroup trmm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/strmv.f b/BLAS/SRC/strmv.f index 0982b51c81..ee4032399c 100644 --- a/BLAS/SRC/strmv.f +++ b/BLAS/SRC/strmv.f @@ -125,7 +125,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup trmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/strsm.f b/BLAS/SRC/strsm.f index 006c16e81d..66a295adfe 100644 --- a/BLAS/SRC/strsm.f +++ b/BLAS/SRC/strsm.f @@ -159,7 +159,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level3 +*> \ingroup trsm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/strsv.f b/BLAS/SRC/strsv.f index 435082b147..46c96deb74 100644 --- a/BLAS/SRC/strsv.f +++ b/BLAS/SRC/strsv.f @@ -128,7 +128,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup single_blas_level2 +*> \ingroup trsv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/xerbla.f b/BLAS/SRC/xerbla.f index 0d73705fad..8262cf498c 100644 --- a/BLAS/SRC/xerbla.f +++ b/BLAS/SRC/xerbla.f @@ -53,7 +53,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup aux_blas +*> \ingroup xerbla * * ===================================================================== SUBROUTINE XERBLA( SRNAME, INFO ) diff --git a/BLAS/SRC/xerbla_array.f b/BLAS/SRC/xerbla_array.f index 1143094bcb..5eeb548047 100644 --- a/BLAS/SRC/xerbla_array.f +++ b/BLAS/SRC/xerbla_array.f @@ -73,7 +73,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup aux_blas +*> \ingroup xerbla_array * * ===================================================================== SUBROUTINE XERBLA_ARRAY(SRNAME_ARRAY, SRNAME_LEN, INFO) diff --git a/BLAS/SRC/zaxpy.f b/BLAS/SRC/zaxpy.f index 35c0e4b892..d39ccfc300 100644 --- a/BLAS/SRC/zaxpy.f +++ b/BLAS/SRC/zaxpy.f @@ -72,7 +72,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level1 +*> \ingroup axpy * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zcopy.f b/BLAS/SRC/zcopy.f index 1efcdb6b0f..c1ea412c93 100644 --- a/BLAS/SRC/zcopy.f +++ b/BLAS/SRC/zcopy.f @@ -65,7 +65,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level1 +*> \ingroup copy * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zdotc.f b/BLAS/SRC/zdotc.f index bcc29e2dad..96b957e988 100644 --- a/BLAS/SRC/zdotc.f +++ b/BLAS/SRC/zdotc.f @@ -67,7 +67,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level1 +*> \ingroup dot * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zdotu.f b/BLAS/SRC/zdotu.f index 11c18da230..82eed8b5d8 100644 --- a/BLAS/SRC/zdotu.f +++ b/BLAS/SRC/zdotu.f @@ -67,7 +67,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level1 +*> \ingroup dot * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zdrot.f b/BLAS/SRC/zdrot.f index 3145561d67..10ac3ac5ee 100644 --- a/BLAS/SRC/zdrot.f +++ b/BLAS/SRC/zdrot.f @@ -91,7 +91,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level1 +*> \ingroup rot * * ===================================================================== SUBROUTINE ZDROT( N, ZX, INCX, ZY, INCY, C, S ) diff --git a/BLAS/SRC/zdscal.f b/BLAS/SRC/zdscal.f index 5a16048771..28fa829942 100644 --- a/BLAS/SRC/zdscal.f +++ b/BLAS/SRC/zdscal.f @@ -61,7 +61,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level1 +*> \ingroup scal * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zgbmv.f b/BLAS/SRC/zgbmv.f index 90b6cef3d0..9375e7d534 100644 --- a/BLAS/SRC/zgbmv.f +++ b/BLAS/SRC/zgbmv.f @@ -165,7 +165,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup gbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zgemm.f b/BLAS/SRC/zgemm.f index 4727310a30..366119577f 100644 --- a/BLAS/SRC/zgemm.f +++ b/BLAS/SRC/zgemm.f @@ -166,7 +166,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level3 +*> \ingroup gemm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zgemv.f b/BLAS/SRC/zgemv.f index 2664454b94..9667501fce 100644 --- a/BLAS/SRC/zgemv.f +++ b/BLAS/SRC/zgemv.f @@ -136,7 +136,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup gemv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zgerc.f b/BLAS/SRC/zgerc.f index 2eb4349367..42060d3899 100644 --- a/BLAS/SRC/zgerc.f +++ b/BLAS/SRC/zgerc.f @@ -109,7 +109,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup ger * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zgeru.f b/BLAS/SRC/zgeru.f index e1cd2dcd19..65df5edc1c 100644 --- a/BLAS/SRC/zgeru.f +++ b/BLAS/SRC/zgeru.f @@ -109,7 +109,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup ger * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zhbmv.f b/BLAS/SRC/zhbmv.f index 6f8026c693..c98a3e4156 100644 --- a/BLAS/SRC/zhbmv.f +++ b/BLAS/SRC/zhbmv.f @@ -165,7 +165,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup hbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zhemm.f b/BLAS/SRC/zhemm.f index bed14cb9a4..3eb5ee6c80 100644 --- a/BLAS/SRC/zhemm.f +++ b/BLAS/SRC/zhemm.f @@ -170,7 +170,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level3 +*> \ingroup hemm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zhemv.f b/BLAS/SRC/zhemv.f index dad68bf25b..444f15647e 100644 --- a/BLAS/SRC/zhemv.f +++ b/BLAS/SRC/zhemv.f @@ -132,7 +132,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup hemv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zher.f b/BLAS/SRC/zher.f index 59227305f8..fd4265e16b 100644 --- a/BLAS/SRC/zher.f +++ b/BLAS/SRC/zher.f @@ -114,7 +114,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup her * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zher2.f b/BLAS/SRC/zher2.f index d1f2b57ec4..7d0a5537cd 100644 --- a/BLAS/SRC/zher2.f +++ b/BLAS/SRC/zher2.f @@ -129,7 +129,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup her2 * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zher2k.f b/BLAS/SRC/zher2k.f index 5c75083cd5..f507ff2520 100644 --- a/BLAS/SRC/zher2k.f +++ b/BLAS/SRC/zher2k.f @@ -174,7 +174,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level3 +*> \ingroup her2k * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zherk.f b/BLAS/SRC/zherk.f index f2665e6da3..ebe35d51e3 100644 --- a/BLAS/SRC/zherk.f +++ b/BLAS/SRC/zherk.f @@ -149,7 +149,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level3 +*> \ingroup herk * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zhpmv.f b/BLAS/SRC/zhpmv.f index c1a2fa006c..ac12365b1a 100644 --- a/BLAS/SRC/zhpmv.f +++ b/BLAS/SRC/zhpmv.f @@ -127,7 +127,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup hpmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zhpr.f b/BLAS/SRC/zhpr.f index 2ba5774a21..5ef5562235 100644 --- a/BLAS/SRC/zhpr.f +++ b/BLAS/SRC/zhpr.f @@ -109,7 +109,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup hpr * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zhpr2.f b/BLAS/SRC/zhpr2.f index 55cfe77e30..8f5a088ce8 100644 --- a/BLAS/SRC/zhpr2.f +++ b/BLAS/SRC/zhpr2.f @@ -124,7 +124,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup hpr2 * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zrotg.f90 b/BLAS/SRC/zrotg.f90 index b3c23be42d..551bea12a5 100644 --- a/BLAS/SRC/zrotg.f90 +++ b/BLAS/SRC/zrotg.f90 @@ -5,19 +5,16 @@ ! Online html documentation available at ! http://www.netlib.org/lapack/explore-html/ ! -! Definition: -! =========== -! -! ZROTG constructs a plane rotation -! [ c s ] [ a ] = [ r ] -! [ -conjg(s) c ] [ b ] [ 0 ] -! where c is real, s is complex, and c**2 + conjg(s)*s = 1. -! !> \par Purpose: ! ============= !> !> \verbatim !> +!> ZROTG constructs a plane rotation +!> [ c s ] [ a ] = [ r ] +!> [ -conjg(s) c ] [ b ] [ 0 ] +!> where c is real, s is complex, and c**2 + conjg(s)*s = 1. +!> !> The computation uses the formulas !> |x| = sqrt( Re(x)**2 + Im(x)**2 ) !> sgn(x) = x / |x| if x /= 0 @@ -33,6 +30,8 @@ !> if the signs of a and b are not the same. !> !> \endverbatim +!> +!> @see lartg, @see lartgp ! ! Arguments: ! ========== @@ -69,7 +68,7 @@ ! !> \date December 2021 ! -!> \ingroup single_blas_level1 +!> \ingroup rotg ! !> \par Further Details: ! ===================== @@ -181,7 +180,7 @@ subroutine ZROTG( a, b, c, s ) f2 = ABSSQ( f ) g2 = ABSSQ( g ) h2 = f2 + g2 - ! safmin <= f2 <= h2 <= safmax + ! safmin <= f2 <= h2 <= safmax if( f2 >= h2 * safmin ) then ! safmin <= f2/h2 <= 1, and h2/f2 is finite c = sqrt( f2 / h2 ) @@ -237,7 +236,7 @@ subroutine ZROTG( a, b, c, s ) f2 = ABSSQ( fs ) h2 = f2 + g2 end if - ! safmin <= f2 <= h2 <= safmax + ! safmin <= f2 <= h2 <= safmax if( f2 >= h2 * safmin ) then ! safmin <= f2/h2 <= 1, and h2/f2 is finite c = sqrt( f2 / h2 ) diff --git a/BLAS/SRC/zscal.f b/BLAS/SRC/zscal.f index 8b8c2c8ab5..8bbb4fdc0e 100644 --- a/BLAS/SRC/zscal.f +++ b/BLAS/SRC/zscal.f @@ -61,7 +61,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level1 +*> \ingroup scal * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zswap.f b/BLAS/SRC/zswap.f index 93f8fc52d0..d27d4321ef 100644 --- a/BLAS/SRC/zswap.f +++ b/BLAS/SRC/zswap.f @@ -65,7 +65,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level1 +*> \ingroup swap * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zsymm.f b/BLAS/SRC/zsymm.f index da491f1aee..7da6a0ee64 100644 --- a/BLAS/SRC/zsymm.f +++ b/BLAS/SRC/zsymm.f @@ -168,7 +168,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level3 +*> \ingroup hemm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zsyr2k.f b/BLAS/SRC/zsyr2k.f index e0f89bb584..40d6fe88e5 100644 --- a/BLAS/SRC/zsyr2k.f +++ b/BLAS/SRC/zsyr2k.f @@ -167,7 +167,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level3 +*> \ingroup her2k * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/zsyrk.f b/BLAS/SRC/zsyrk.f index 143a5e235a..c9ddc6cad8 100644 --- a/BLAS/SRC/zsyrk.f +++ b/BLAS/SRC/zsyrk.f @@ -146,7 +146,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level3 +*> \ingroup herk * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ztbmv.f b/BLAS/SRC/ztbmv.f index 347a71af86..1a11d3a15b 100644 --- a/BLAS/SRC/ztbmv.f +++ b/BLAS/SRC/ztbmv.f @@ -164,7 +164,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup tbmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ztbsv.f b/BLAS/SRC/ztbsv.f index bbc8cef968..b3042ac8f8 100644 --- a/BLAS/SRC/ztbsv.f +++ b/BLAS/SRC/ztbsv.f @@ -168,7 +168,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup tbsv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ztpmv.f b/BLAS/SRC/ztpmv.f index 27ae4d8a81..be20048da9 100644 --- a/BLAS/SRC/ztpmv.f +++ b/BLAS/SRC/ztpmv.f @@ -120,7 +120,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup tpmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ztpsv.f b/BLAS/SRC/ztpsv.f index a29a26dba4..436fb07c12 100644 --- a/BLAS/SRC/ztpsv.f +++ b/BLAS/SRC/ztpsv.f @@ -123,7 +123,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup tpsv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ztrmm.f b/BLAS/SRC/ztrmm.f index 4b7deb1199..e11313dffc 100644 --- a/BLAS/SRC/ztrmm.f +++ b/BLAS/SRC/ztrmm.f @@ -156,7 +156,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level3 +*> \ingroup trmm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ztrmv.f b/BLAS/SRC/ztrmv.f index e50bfdb089..f72def8a4b 100644 --- a/BLAS/SRC/ztrmv.f +++ b/BLAS/SRC/ztrmv.f @@ -125,7 +125,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup trmv * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ztrsm.f b/BLAS/SRC/ztrsm.f index aed1eabf8b..8479bf7766 100644 --- a/BLAS/SRC/ztrsm.f +++ b/BLAS/SRC/ztrsm.f @@ -159,7 +159,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level3 +*> \ingroup trsm * *> \par Further Details: * ===================== diff --git a/BLAS/SRC/ztrsv.f b/BLAS/SRC/ztrsv.f index 8b41871cdf..6587355324 100644 --- a/BLAS/SRC/ztrsv.f +++ b/BLAS/SRC/ztrsv.f @@ -128,7 +128,7 @@ *> \author Univ. of Colorado Denver *> \author NAG Ltd. * -*> \ingroup complex16_blas_level2 +*> \ingroup trsv * *> \par Further Details: * ===================== diff --git a/CMakeLists.txt b/CMakeLists.txt index df253f0e18..611178beb2 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -673,22 +673,34 @@ if(BUILD_HTML_DOCUMENTATION OR BUILD_MAN_DOCUMENTATION) set(DOXYGEN_PROJECT_BRIEF "LAPACK: Linear Algebra PACKage") set(DOXYGEN_PROJECT_NUMBER ${LAPACK_VERSION}) set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/DOCS) - set(PROJECT_LOGO ${CMAKE_CURRENT_SOURCE_DIR}/DOCS/lapack.png) + set(DOXYGEN_PROJECT_LOGO ${CMAKE_CURRENT_SOURCE_DIR}/DOCS/lapack.png) set(DOXYGEN_OPTIMIZE_FOR_FORTRAN YES) set(DOXYGEN_SOURCE_BROWSER YES) - set(DISTRIBUTE_GROUP_DOC YES) set(DOXYGEN_CREATE_SUBDIRS YES) set(DOXYGEN_SEPARATE_MEMBER_PAGES YES) set(DOXYGEN_EXTRACT_ALL YES) - set(DOXYGEN_FILE_PATTERNS "*.f;*.c;*.h") + set(DOXYGEN_FILE_PATTERNS *.f *.f90 *.c *.h ) set(DOXYGEN_RECURSIVE YES) set(DOXYGEN_GENERATE_TREEVIEW YES) + set(DOXYGEN_DOT_IMAGE_FORMAT svg) set(DOXYGEN_INTERACTIVE_SVG YES) - set(DOXYGEN_QUIET YES) - set(DOXYGEN_WARNINGS NO) + set(DOXYGEN_QUIET NO) + set(DOXYGEN_WARNINGS YES) + set(DOXYGEN_WARN_NO_PARAMDOC YES) + set(DOXYGEN_WARN_LOGFILE doxygen_error) set(DOXYGEN_GENERATE_HTML NO) set(DOXYGEN_GENERATE_MAN NO) - + set(DOXYGEN_LAYOUT_FILE "DOCS/DoxygenLayout.xml") + + # Exclude functions that are duplicated, creating conflicts. + set(DOXYGEN_EXCLUDE .git + .github + SRC/VARIANTS + BLAS/SRC/lsame.f + BLAS/SRC/xerbla.f + BLAS/SRC/xerbla_array.f + INSTALL/slamchf77.f + INSTALL/dlamchf77.f ) if (BUILD_HTML_DOCUMENTATION) set(DOXYGEN_GENERATE_HTML YES) @@ -699,13 +711,21 @@ if(BUILD_HTML_DOCUMENTATION OR BUILD_MAN_DOCUMENTATION) doxygen_add_docs( html - ${PROJECT_SOURCE_DIR} + + # Doxygen INPUT = + ${PROJECT_SOURCE_DIR}/README.md + ${PROJECT_SOURCE_DIR}/BLAS + ${PROJECT_SOURCE_DIR}/CBLAS + ${PROJECT_SOURCE_DIR}/SRC + ${PROJECT_SOURCE_DIR}/INSTALL + ${PROJECT_SOURCE_DIR}/TESTING + ${PROJECT_SOURCE_DIR}/DOCS/groups-usr.dox + COMMENT "Generating html LAPACK documentation (it will take some time... time to grab a coffee)" ) endif() if (BUILD_MAN_DOCUMENTATION) set(DOXYGEN_GENERATE_MAN YES) - set(DOXYGEN_EXCLUDE SRC/VARIANTS) set(DOXYGEN_MAN_LINKS YES) set(DOXYGEN_INLINE_SOURCES NO) set(DOXYGEN_CALL_GRAPH NO) @@ -713,7 +733,15 @@ if(BUILD_HTML_DOCUMENTATION OR BUILD_MAN_DOCUMENTATION) doxygen_add_docs( man - ${PROJECT_SOURCE_DIR} + + # Doxygen INPUT = + ${PROJECT_SOURCE_DIR}/BLAS + ${PROJECT_SOURCE_DIR}/CBLAS + ${PROJECT_SOURCE_DIR}/SRC + ${PROJECT_SOURCE_DIR}/INSTALL + ${PROJECT_SOURCE_DIR}/TESTING + ${PROJECT_SOURCE_DIR}/DOCS/groups-usr.dox + COMMENT "Generating man LAPACK documentation" ) endif() diff --git a/DOCS/Doxyfile b/DOCS/Doxyfile index 97415241c4..0eadfdf27e 100644 --- a/DOCS/Doxyfile +++ b/DOCS/Doxyfile @@ -387,7 +387,7 @@ IDL_PROPERTY_SUPPORT = YES # all members of a group must be documented explicitly. # The default value is: NO. -DISTRIBUTE_GROUP_DOC = YES +DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option @@ -763,7 +763,7 @@ FILE_VERSION_FILTER = # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = DOCS/DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib @@ -784,7 +784,7 @@ CITE_BIB_FILES = # messages are off. # The default value is: NO. -QUIET = YES +QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES @@ -817,7 +817,7 @@ WARN_IF_DOC_ERROR = YES # EXTRACT_ALL is set to YES then this flag will automatically be disabled. # The default value is: NO. -WARN_NO_PARAMDOC = NO +WARN_NO_PARAMDOC = YES # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS @@ -842,7 +842,7 @@ WARN_FORMAT = "$file:$line: $text" # messages should be written. If left blank the output is written to standard # error (stderr). -WARN_LOGFILE = output_err +WARN_LOGFILE = doxygen_error #--------------------------------------------------------------------------- # Configuration options related to the input files @@ -854,8 +854,9 @@ WARN_LOGFILE = output_err # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = . \ - DOCS/groups-usr.dox +INPUT = BLAS CBLAS SRC INSTALL TESTING \ + DOCS/groups-usr.dox \ + README.md # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -902,34 +903,15 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = CMAKE \ - DOCS \ - .svn \ - CBLAS/.svn \ - CBLAS/src/.svn \ - CBLAS/testing/.svn \ - CBLAS/example/.svn \ - CBLAS/include/.svn \ - BLAS/.svn \ - BLAS/SRC/.svn \ - BLAS/TESTING/.svn \ - SRC/.svn \ - SRC/VARIANTS/.svn \ - SRC/VARIANTS/LIB/.svn \ - SRC/VARIANTS/cholesky/.svn \ - SRC/VARIANTS/cholesky/RL/.svn \ - SRC/VARIANTS/cholesky/TOP/.svn \ - SRC/VARIANTS/lu/.svn \ - SRC/VARIANTS/lu/CR/.svn \ - SRC/VARIANTS/lu/LL/.svn \ - SRC/VARIANTS/lu/REC/.svn \ - SRC/VARIANTS/qr/.svn \ - SRC/VARIANTS/qr/LL/.svn \ - INSTALL/.svn \ - TESTING/.svn \ - TESTING/EIG/.svn \ - TESTING/MATGEN/.svn \ - TESTING/LIN/.svn +# Exclude functions that are duplicated, creating conflicts. +EXCLUDE = .git \ + .github \ + SRC/VARIANTS \ + BLAS/SRC/lsame.f \ + BLAS/SRC/xerbla.f \ + BLAS/SRC/xerbla_array.f \ + INSTALL/slamchf77.f \ + INSTALL/dlamchf77.f \ # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded diff --git a/DOCS/Doxyfile_man b/DOCS/Doxyfile_man deleted file mode 100644 index 6625de4566..0000000000 --- a/DOCS/Doxyfile_man +++ /dev/null @@ -1,2578 +0,0 @@ -# Doxyfile 1.9.1 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project. -# -# All text after a double hash (##) is considered a comment and is placed in -# front of the TAG it is preceding. -# -# All text after a single hash (#) is considered a comment and will be ignored. -# The format is: -# TAG = value [value, ...] -# For lists, items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (\" \"). - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# This tag specifies the encoding used for all characters in the configuration -# file that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# https://www.gnu.org/software/libiconv/ for the list of possible encodings. -# The default value is: UTF-8. - -DOXYFILE_ENCODING = UTF-8 - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by -# double-quotes, unless you are using Doxywizard) that should identify the -# project for which the documentation is generated. This name is used in the -# title of most generated pages and in a few other places. -# The default value is: My Project. - -PROJECT_NAME = LAPACK - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. This -# could be handy for archiving the generated documentation or if some version -# control system is used. - -PROJECT_NUMBER = 3.11.0 - -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer a -# quick idea about the purpose of the project. Keep the description short. - -PROJECT_BRIEF = "LAPACK: Linear Algebra PACKage" - -# With the PROJECT_LOGO tag one can specify a logo or an icon that is included -# in the documentation. The maximum height of the logo should not exceed 55 -# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy -# the logo to the output directory. - -PROJECT_LOGO = DOCS/lapack.png - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path -# into which the generated documentation will be written. If a relative path is -# entered, it will be relative to the location where doxygen was started. If -# left blank the current directory will be used. - -OUTPUT_DIRECTORY = DOCS - -# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- -# directories (in 2 levels) under the output directory of each output format and -# will distribute the generated files over these directories. Enabling this -# option can be useful when feeding doxygen a huge amount of source files, where -# putting all generated files in the same directory would otherwise causes -# performance problems for the file system. -# The default value is: NO. - -CREATE_SUBDIRS = NO - -# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII -# characters to appear in the names of generated files. If set to NO, non-ASCII -# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode -# U+3044. -# The default value is: NO. - -ALLOW_UNICODE_NAMES = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, -# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), -# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, -# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), -# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, -# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, -# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, -# Ukrainian and Vietnamese. -# The default value is: English. - -OUTPUT_LANGUAGE = English - -# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all generated output in the proper direction. -# Possible values are: None, LTR, RTL and Context. -# The default value is: None. - -OUTPUT_TEXT_DIRECTION = None - -# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member -# descriptions after the members that are listed in the file and class -# documentation (similar to Javadoc). Set to NO to disable this. -# The default value is: YES. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief -# description of a member or function before the detailed description -# -# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. -# The default value is: YES. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator that is -# used to form the text in various listings. Each string in this list, if found -# as the leading text of the brief description, will be stripped from the text -# and the result, after processing the whole list, is used as the annotated -# text. Otherwise, the brief description is used as-is. If left blank, the -# following values are used ($name is automatically replaced with the name of -# the entity):The $name class, The $name widget, The $name file, is, provides, -# specifies, contains, represents, a, an and the. - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# doxygen will generate a detailed section even if there is only a brief -# description. -# The default value is: NO. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. -# The default value is: NO. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path -# before files name in the file list and in the header files. If set to NO the -# shortest path that makes the file name unique will be used -# The default value is: YES. - -FULL_PATH_NAMES = NO - -# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. -# Stripping is only done if one of the specified strings matches the left-hand -# part of the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the path to -# strip. -# -# Note that you can specify absolute paths here, but also relative paths, which -# will be relative from the directory where doxygen is started. -# This tag requires that the tag FULL_PATH_NAMES is set to YES. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the -# path mentioned in the documentation of a class, which tells the reader which -# header file to include in order to use a class. If left blank only the name of -# the header file containing the class definition is used. Otherwise one should -# specify the list of include paths that are normally passed to the compiler -# using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but -# less readable) file names. This can be useful is your file systems doesn't -# support long names like on DOS, Mac, or CD-ROM. -# The default value is: NO. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the -# first line (until the first dot) of a Javadoc-style comment as the brief -# description. If set to NO, the Javadoc-style will behave just like regular Qt- -# style comments (thus requiring an explicit @brief command for a brief -# description.) -# The default value is: NO. - -JAVADOC_AUTOBRIEF = NO - -# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line -# such as -# /*************** -# as being the beginning of a Javadoc-style comment "banner". If set to NO, the -# Javadoc-style will behave just like regular comments and it will not be -# interpreted by doxygen. -# The default value is: NO. - -JAVADOC_BANNER = NO - -# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first -# line (until the first dot) of a Qt-style comment as the brief description. If -# set to NO, the Qt-style will behave just like regular Qt-style comments (thus -# requiring an explicit \brief command for a brief description.) -# The default value is: NO. - -QT_AUTOBRIEF = NO - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a -# multi-line C++ special comment block (i.e. a block of //! or /// comments) as -# a brief description. This used to be the default behavior. The new default is -# to treat a multi-line C++ comment block as a detailed description. Set this -# tag to YES if you prefer the old behavior instead. -# -# Note that setting this tag to YES also means that rational rose comments are -# not recognized any more. -# The default value is: NO. - -MULTILINE_CPP_IS_BRIEF = NO - -# By default Python docstrings are displayed as preformatted text and doxygen's -# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the -# doxygen's special commands can be used and the contents of the docstring -# documentation blocks is shown as doxygen documentation. -# The default value is: YES. - -PYTHON_DOCSTRING = YES - -# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the -# documentation from any documented member that it re-implements. -# The default value is: YES. - -INHERIT_DOCS = YES - -# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new -# page for each member. If set to NO, the documentation of a member will be part -# of the file/class/namespace that contains it. -# The default value is: NO. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen -# uses this value to replace tabs by spaces in code fragments. -# Minimum value: 1, maximum value: 16, default value: 4. - -TAB_SIZE = 8 - -# This tag can be used to specify a number of aliases that act as commands in -# the documentation. An alias has the form: -# name=value -# For example adding -# "sideeffect=@par Side Effects:\n" -# will allow you to put the command \sideeffect (or @sideeffect) in the -# documentation, which will result in a user-defined paragraph with heading -# "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines (in the resulting output). You can put ^^ in the value part of an -# alias to insert a newline as if a physical newline was in the original file. -# When you need a literal { or } or , in the value part of an alias you have to -# escape them by means of a backslash (\), this can lead to conflicts with the -# commands \{ and \} for these it is advised to use the version @{ and @} or use -# a double escape (\\{ and \\}) - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources -# only. Doxygen will then generate output that is more tailored for C. For -# instance, some of the names that are used will be different. The list of all -# members will be omitted, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or -# Python sources only. Doxygen will then generate output that is more tailored -# for that language. For instance, namespaces will be presented as packages, -# qualified scopes will look different, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources. Doxygen will then generate output that is tailored for Fortran. -# The default value is: NO. - -OPTIMIZE_FOR_FORTRAN = YES - -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for VHDL. -# The default value is: NO. - -OPTIMIZE_OUTPUT_VHDL = NO - -# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice -# sources only. Doxygen will then generate output that is more tailored for that -# language. For instance, namespaces will be presented as modules, types will be -# separated into more groups, etc. -# The default value is: NO. - -OPTIMIZE_OUTPUT_SLICE = NO - -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, and -# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, -# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, -# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: -# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser -# tries to guess whether the code is fixed or free formatted code, this is the -# default for Fortran type files). For instance to make doxygen treat .inc files -# as Fortran files (default is PHP), and .f files as C (default is Fortran), -# use: inc=Fortran f=C. -# -# Note: For files without extension you can use no_extension as a placeholder. -# -# Note that for custom extensions you also need to set FILE_PATTERNS otherwise -# the files are not read by doxygen. When specifying no_extension you should add -# * to the FILE_PATTERNS. -# -# Note see also the list of default file extension mappings. - -EXTENSION_MAPPING = - -# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments -# according to the Markdown format, which allows for more readable -# documentation. See https://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you can -# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in -# case of backward compatibilities issues. -# The default value is: YES. - -MARKDOWN_SUPPORT = YES - -# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up -# to that level are automatically included in the table of contents, even if -# they do not have an id attribute. -# Note: This feature currently applies only to Markdown headings. -# Minimum value: 0, maximum value: 99, default value: 5. -# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. - -TOC_INCLUDE_HEADINGS = 5 - -# When enabled doxygen tries to link words that correspond to documented -# classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by putting a % sign in front of the word or -# globally by setting AUTOLINK_SUPPORT to NO. -# The default value is: YES. - -AUTOLINK_SUPPORT = YES - -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should set this -# tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); -# versus func(std::string) {}). This also make the inheritance and collaboration -# diagrams that involve STL classes more complete and accurate. -# The default value is: NO. - -BUILTIN_STL_SUPPORT = NO - -# If you use Microsoft's C++/CLI language, you should set this option to YES to -# enable parsing support. -# The default value is: NO. - -CPP_CLI_SUPPORT = NO - -# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen -# will parse them like normal C++ but will assume all classes use public instead -# of private inheritance when no explicit protection keyword is present. -# The default value is: NO. - -SIP_SUPPORT = NO - -# For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES will make -# doxygen to replace the get and set methods by a property in the documentation. -# This will only work if the methods are indeed getting or setting a simple -# type. If this is not the case, or you want to show the methods anyway, you -# should set this option to NO. -# The default value is: YES. - -IDL_PROPERTY_SUPPORT = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. -# The default value is: NO. - -DISTRIBUTE_GROUP_DOC = YES - -# If one adds a struct or class to a group and this option is enabled, then also -# any nested class or struct is added to the same group. By default this option -# is disabled and one has to add nested compounds explicitly via \ingroup. -# The default value is: NO. - -GROUP_NESTED_COMPOUNDS = NO - -# Set the SUBGROUPING tag to YES to allow class member groups of the same type -# (for instance a group of public functions) to be put as a subgroup of that -# type (e.g. under the Public Functions section). Set it to NO to prevent -# subgrouping. Alternatively, this can be done per class using the -# \nosubgrouping command. -# The default value is: YES. - -SUBGROUPING = YES - -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions -# are shown inside the group in which they are included (e.g. using \ingroup) -# instead of on a separate page (for HTML and Man pages) or section (for LaTeX -# and RTF). -# -# Note that this feature does not work in combination with -# SEPARATE_MEMBER_PAGES. -# The default value is: NO. - -INLINE_GROUPED_CLASSES = NO - -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions -# with only public data fields or simple typedef fields will be shown inline in -# the documentation of the scope in which they are defined (i.e. file, -# namespace, or group documentation), provided this scope is documented. If set -# to NO, structs, classes, and unions are shown on a separate page (for HTML and -# Man pages) or section (for LaTeX and RTF). -# The default value is: NO. - -INLINE_SIMPLE_STRUCTS = NO - -# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or -# enum is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically be -# useful for C code in case the coding convention dictates that all compound -# types are typedef'ed and only the typedef is referenced, never the tag name. -# The default value is: NO. - -TYPEDEF_HIDES_STRUCT = NO - -# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This -# cache is used to resolve symbols given their name and scope. Since this can be -# an expensive process and often the same symbol appears multiple times in the -# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small -# doxygen will become slower. If the cache is too large, memory is wasted. The -# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range -# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 -# symbols. At the end of a run doxygen will report the cache usage and suggest -# the optimal cache size from a speed point of view. -# Minimum value: 0, maximum value: 9, default value: 0. - -LOOKUP_CACHE_SIZE = 0 - -# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use -# during processing. When set to 0 doxygen will based this on the number of -# cores available in the system. You can set it explicitly to a value larger -# than 0 to get more control over the balance between CPU load and processing -# speed. At this moment only the input processing can be done using multiple -# threads. Since this is still an experimental feature the default is set to 1, -# which efficively disables parallel processing. Please report any issues you -# encounter. Generating dot graphs in parallel is controlled by the -# DOT_NUM_THREADS setting. -# Minimum value: 0, maximum value: 32, default value: 1. - -NUM_PROC_THREADS = 1 - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in -# documentation are documented, even if no documentation was available. Private -# class members and static file members will be hidden unless the -# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. -# Note: This will also disable the warnings about undocumented members that are -# normally produced when WARNINGS is set to YES. -# The default value is: NO. - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will -# be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIVATE = NO - -# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual -# methods of a class will be included in the documentation. -# The default value is: NO. - -EXTRACT_PRIV_VIRTUAL = NO - -# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal -# scope will be included in the documentation. -# The default value is: NO. - -EXTRACT_PACKAGE = NO - -# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be -# included in the documentation. -# The default value is: NO. - -EXTRACT_STATIC = NO - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO, -# only classes defined in header files are included. Does not have any effect -# for Java sources. -# The default value is: YES. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. If set to YES, local methods, -# which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO, only methods in the interface are -# included. -# The default value is: NO. - -EXTRACT_LOCAL_METHODS = NO - -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base name of -# the file that contains the anonymous namespace. By default anonymous namespace -# are hidden. -# The default value is: NO. - -EXTRACT_ANON_NSPACES = NO - -# If this flag is set to YES, the name of an unnamed parameter in a declaration -# will be determined by the corresponding definition. By default unnamed -# parameters remain unnamed in the output. -# The default value is: YES. - -RESOLVE_UNNAMED_PARAMS = YES - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all -# undocumented members inside documented classes or files. If set to NO these -# members will be included in the various overviews, but no documentation -# section is generated. This option has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. If set -# to NO, these classes will be included in the various overviews. This option -# has no effect if EXTRACT_ALL is enabled. -# The default value is: NO. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# declarations. If set to NO, these declarations will be included in the -# documentation. -# The default value is: NO. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO, these -# blocks will be appended to the function's detailed documentation block. -# The default value is: NO. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation that is typed after a -# \internal command is included. If the tag is set to NO then the documentation -# will be excluded. Set it to YES to include the internal documentation. -# The default value is: NO. - -INTERNAL_DOCS = NO - -# With the correct setting of option CASE_SENSE_NAMES doxygen will better be -# able to match the capabilities of the underlying filesystem. In case the -# filesystem is case sensitive (i.e. it supports files in the same directory -# whose names only differ in casing), the option must be set to YES to properly -# deal with such files in case they appear in the input. For filesystems that -# are not case sensitive the option should be be set to NO to properly deal with -# output files written for symbols that only differ in casing, such as for two -# classes, one named CLASS and the other named Class, and to also support -# references to files without having to specify the exact matching casing. On -# Windows (including Cygwin) and MacOS, users should typically set this option -# to NO, whereas on Linux or other Unix flavors it should typically be set to -# YES. -# The default value is: system dependent. - -CASE_SENSE_NAMES = NO - -# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES, the -# scope will be hidden. -# The default value is: NO. - -HIDE_SCOPE_NAMES = NO - -# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will -# append additional text to a page's title, such as Class Reference. If set to -# YES the compound reference will be hidden. -# The default value is: NO. - -HIDE_COMPOUND_REFERENCE= NO - -# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of -# the files that are included by a file in the documentation of that file. -# The default value is: YES. - -SHOW_INCLUDE_FILES = YES - -# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each -# grouped member an include statement to the documentation, telling the reader -# which file to include in order to use the member. -# The default value is: NO. - -SHOW_GROUPED_MEMB_INC = NO - -# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include -# files with double quotes in the documentation rather than with sharp brackets. -# The default value is: NO. - -FORCE_LOCAL_INCLUDES = NO - -# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the -# documentation for inline members. -# The default value is: YES. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the -# (detailed) documentation of file and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. -# The default value is: YES. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief -# descriptions of file, namespace and class members alphabetically by member -# name. If set to NO, the members will appear in declaration order. Note that -# this will also influence the order of the classes in the class list. -# The default value is: NO. - -SORT_BRIEF_DOCS = NO - -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the -# (brief and detailed) documentation of class members so that constructors and -# destructors are listed first. If set to NO the constructors will appear in the -# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. -# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief -# member documentation. -# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting -# detailed member documentation. -# The default value is: NO. - -SORT_MEMBERS_CTORS_1ST = NO - -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy -# of group names into alphabetical order. If set to NO the group names will -# appear in their defined order. -# The default value is: NO. - -SORT_GROUP_NAMES = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by -# fully-qualified names, including namespaces. If set to NO, the class list will -# be sorted only by class name, not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the alphabetical -# list. -# The default value is: NO. - -SORT_BY_SCOPE_NAME = NO - -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper -# type resolution of all parameters of a function it will reject a match between -# the prototype and the implementation of a member function even if there is -# only one candidate or it is obvious which candidate to choose by doing a -# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still -# accept a match between prototype and implementation in such cases. -# The default value is: NO. - -STRICT_PROTO_MATCHING = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo -# list. This list is created by putting \todo commands in the documentation. -# The default value is: YES. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test -# list. This list is created by putting \test commands in the documentation. -# The default value is: YES. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug -# list. This list is created by putting \bug commands in the documentation. -# The default value is: YES. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) -# the deprecated list. This list is created by putting \deprecated commands in -# the documentation. -# The default value is: YES. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional documentation -# sections, marked by \if ... \endif and \cond -# ... \endcond blocks. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the -# initial value of a variable or macro / define can have for it to appear in the -# documentation. If the initializer consists of more lines than specified here -# it will be hidden. Use a value of 0 to hide initializers completely. The -# appearance of the value of individual variables and macros / defines can be -# controlled using \showinitializer or \hideinitializer command in the -# documentation regardless of this setting. -# Minimum value: 0, maximum value: 10000, default value: 30. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES, the -# list will mention the files that were used to generate the documentation. -# The default value is: YES. - -SHOW_USED_FILES = YES - -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This -# will remove the Files entry from the Quick Index and from the Folder Tree View -# (if specified). -# The default value is: YES. - -SHOW_FILES = YES - -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces -# page. This will remove the Namespaces entry from the Quick Index and from the -# Folder Tree View (if specified). -# The default value is: YES. - -SHOW_NAMESPACES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command command input-file, where command is the value of the -# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided -# by doxygen. Whatever the program writes to standard output is used as the file -# version. For an example see the documentation. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. You can -# optionally specify a file name after the option, if omitted DoxygenLayout.xml -# will be used as the name of the layout file. -# -# Note that if you run doxygen from a directory containing a file called -# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE -# tag is left empty. - -LAYOUT_FILE = - -# The CITE_BIB_FILES tag can be used to specify one or more bib files containing -# the reference definitions. This must be a list of .bib files. The .bib -# extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. -# For LaTeX the style of the bibliography can be controlled using -# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. See also \cite for info how to create references. - -CITE_BIB_FILES = - -#--------------------------------------------------------------------------- -# Configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated to -# standard output by doxygen. If QUIET is set to YES this implies that the -# messages are off. -# The default value is: NO. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES -# this implies that the warnings are on. -# -# Tip: Turn warnings on while writing the documentation. -# The default value is: YES. - -WARNINGS = YES - -# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate -# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag -# will automatically be disabled. -# The default value is: YES. - -WARN_IF_UNDOCUMENTED = YES - -# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some parameters -# in a documented function, or documenting parameters that don't exist or using -# markup commands wrongly. -# The default value is: YES. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that -# are documented, but have no documentation for their parameters or return -# value. If set to NO, doxygen will only warn about wrong or incomplete -# parameter documentation, but not about the absence of documentation. If -# EXTRACT_ALL is set to YES then this flag will automatically be disabled. -# The default value is: NO. - -WARN_NO_PARAMDOC = NO - -# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when -# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS -# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but -# at the end of the doxygen process doxygen will return with a non-zero status. -# Possible values are: NO, YES and FAIL_ON_WARNINGS. -# The default value is: NO. - -WARN_AS_ERROR = NO - -# The WARN_FORMAT tag determines the format of the warning messages that doxygen -# can produce. The string should contain the $file, $line, and $text tags, which -# will be replaced by the file and line number from which the warning originated -# and the warning text. Optionally the format may contain $version, which will -# be replaced by the version of the file (if it could be obtained via -# FILE_VERSION_FILTER) -# The default value is: $file:$line: $text. - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning and error -# messages should be written. If left blank the output is written to standard -# error (stderr). - -WARN_LOGFILE = output_err - -#--------------------------------------------------------------------------- -# Configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag is used to specify the files and/or directories that contain -# documented source files. You may enter file names like myfile.cpp or -# directories like /usr/src/myproject. Separate the files or directories with -# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING -# Note: If this tag is empty the current directory is searched. - -INPUT = . \ - DOCS/groups-usr.dox - -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses -# libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: -# https://www.gnu.org/software/libiconv/) for the list of possible encodings. -# The default value is: UTF-8. - -INPUT_ENCODING = UTF-8 - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# read by doxygen. -# -# Note the list of default checked file patterns might differ from the list of -# default file extension mappings. -# -# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, -# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, -# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), -# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, -# *.ucf, *.qsf and *.ice. - -FILE_PATTERNS = *.c \ - *.f \ - *.h - -# The RECURSIVE tag can be used to specify whether or not subdirectories should -# be searched for input files as well. -# The default value is: NO. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# -# Note that relative paths are relative to the directory from which doxygen is -# run. - -EXCLUDE = CMAKE \ - DOCS \ - BLAS/TESTING \ - CBLAS \ - LAPACKE/mangling \ - INSTALL \ - SRC/DEPRECATED \ - TESTING - -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded -# from the input. -# The default value is: NO. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories for example use the pattern */test/* - -EXCLUDE_PATTERNS = *.py \ - *.txt \ - *.in \ - *.inc \ - Makefile - -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, -# AClass::ANamespace, ANamespace::*Test -# -# Note that the wildcards are matched against the file with absolute path, so to -# exclude all test directories use the pattern */test/* - -EXCLUDE_SYMBOLS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or directories -# that contain example code fragments that are included (see the \include -# command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank all -# files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude commands -# irrespective of the value of the RECURSIVE tag. -# The default value is: NO. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or directories -# that contain images that are to be included in the documentation (see the -# \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command: -# -# -# -# where is the value of the INPUT_FILTER tag, and is the -# name of an input file. Doxygen will then use the output that the filter -# program writes to standard output. If FILTER_PATTERNS is specified, this tag -# will be ignored. -# -# Note that the filter must not add or remove lines; it is applied before the -# code is scanned, but not when the output code is generated. If lines are added -# or removed, the anchors will not be placed correctly. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: pattern=filter -# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how -# filters are used. If the FILTER_PATTERNS tag is empty or if none of the -# patterns match the file name, INPUT_FILTER is applied. -# -# Note that for custom extensions or not directly supported extensions you also -# need to set EXTENSION_MAPPING for the extension otherwise the files are not -# properly processed by doxygen. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will also be used to filter the input files that are used for -# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). -# The default value is: NO. - -FILTER_SOURCE_FILES = NO - -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and -# it is also possible to disable source filtering for a specific pattern using -# *.ext= (so without naming a filter). -# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. - -FILTER_SOURCE_PATTERNS = - -# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that -# is part of the input, its contents will be placed on the main page -# (index.html). This can be useful if you have a project on for instance GitHub -# and want to reuse the introduction page also for the doxygen output. - -USE_MDFILE_AS_MAINPAGE = - -#--------------------------------------------------------------------------- -# Configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will be -# generated. Documented entities will be cross-referenced with these sources. -# -# Note: To get rid of all source code in the generated output, make sure that -# also VERBATIM_HEADERS is set to NO. -# The default value is: NO. - -SOURCE_BROWSER = YES - -# Setting the INLINE_SOURCES tag to YES will include the body of functions, -# classes and enums directly into the documentation. -# The default value is: NO. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any -# special comment blocks from generated source code fragments. Normal C, C++ and -# Fortran comments will always remain visible. -# The default value is: YES. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# entity all documented functions referencing it will be listed. -# The default value is: NO. - -REFERENCED_BY_RELATION = NO - -# If the REFERENCES_RELATION tag is set to YES then for each documented function -# all documented entities called/used by that function will be listed. -# The default value is: NO. - -REFERENCES_RELATION = NO - -# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES then the hyperlinks from functions in REFERENCES_RELATION and -# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will -# link to the documentation. -# The default value is: YES. - -REFERENCES_LINK_SOURCE = YES - -# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the -# source code will show a tooltip with additional information such as prototype, -# brief description and links to the definition and documentation. Since this -# will make the HTML file larger and loading of large files a bit slower, you -# can opt to disable this feature. -# The default value is: YES. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -SOURCE_TOOLTIPS = YES - -# If the USE_HTAGS tag is set to YES then the references to source code will -# point to the HTML generated by the htags(1) tool instead of doxygen built-in -# source browser. The htags tool is part of GNU's global source tagging system -# (see https://www.gnu.org/software/global/global.html). You will need version -# 4.8.6 or higher. -# -# To use it do the following: -# - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file -# - Make sure the INPUT points to the root of the source tree -# - Run doxygen as normal -# -# Doxygen will invoke htags (and that will in turn invoke gtags), so these -# tools must be available from the command line (i.e. in the search path). -# -# The result: instead of the source browser generated by doxygen, the links to -# source code will now point to the output of htags. -# The default value is: NO. -# This tag requires that the tag SOURCE_BROWSER is set to YES. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a -# verbatim copy of the header file for each class for which an include is -# specified. Set to NO to disable this. -# See also: Section \class. -# The default value is: YES. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# Configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all -# compounds will be generated. Enable this if the project contains a lot of -# classes, structs, unions or interfaces. -# The default value is: YES. - -ALPHABETICAL_INDEX = YES - -# In case all classes in a project start with a common prefix, all classes will -# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag -# can be used to specify a prefix (or a list of prefixes) that should be ignored -# while generating the index headers. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output -# The default value is: YES. - -GENERATE_HTML = NO - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a -# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of -# it. -# The default directory is: html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_OUTPUT = explore-html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each -# generated HTML page (for example: .htm, .php, .asp). -# The default value is: .html. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a user-defined HTML header file for -# each generated HTML page. If the tag is left blank doxygen will generate a -# standard header. -# -# To get valid HTML the header file that includes any scripts and style sheets -# that doxygen needs, which is dependent on the configuration options used (e.g. -# the setting GENERATE_TREEVIEW). It is highly recommended to start with a -# default header using -# doxygen -w html new_header.html new_footer.html new_stylesheet.css -# YourConfigFile -# and then modify the file new_header.html. See also section "Doxygen usage" -# for information on how to generate the default header that doxygen normally -# uses. -# Note: The header is subject to change so you typically have to regenerate the -# default header when upgrading to a newer version of doxygen. For a description -# of the possible markers and block names see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each -# generated HTML page. If the tag is left blank doxygen will generate a standard -# footer. See HTML_HEADER for more information on how to generate a default -# footer and what special commands can be used inside the footer. See also -# section "Doxygen usage" for information on how to generate the default footer -# that doxygen normally uses. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style -# sheet that is used by each HTML page. It can be used to fine-tune the look of -# the HTML output. If left blank doxygen will generate a default style sheet. -# See also section "Doxygen usage" for information on how to generate the style -# sheet that doxygen normally uses. -# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as -# it is more robust and this tag (HTML_STYLESHEET) will in the future become -# obsolete. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined -# cascading style sheets that are included after the standard style sheets -# created by doxygen. Using this option one can overrule certain style aspects. -# This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefore more robust against future updates. -# Doxygen will copy the style sheet files to the output directory. -# Note: The order of the extra style sheet files is of importance (e.g. the last -# style sheet in the list overrules the setting of the previous ones in the -# list). For an example see the documentation. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that the -# files will be copied as-is; there are no commands or markers available. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the style sheet and background images according to -# this color. Hue is specified as an angle on a colorwheel, see -# https://en.wikipedia.org/wiki/Hue for more information. For instance the value -# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 -# purple, and 360 is red again. -# Minimum value: 0, maximum value: 359, default value: 220. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_HUE = 220 - -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors -# in the HTML output. For a value of 0 the output will use grayscales only. A -# value of 255 will produce the most vivid colors. -# Minimum value: 0, maximum value: 255, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_SAT = 100 - -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the -# luminance component of the colors in the HTML output. Values below 100 -# gradually make the output lighter, whereas values above 100 make the output -# darker. The value divided by 100 is the actual gamma applied, so 80 represents -# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not -# change the gamma. -# Minimum value: 40, maximum value: 240, default value: 80. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_COLORSTYLE_GAMMA = 80 - -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting this -# to YES can help to show when doxygen was last run and thus if the -# documentation is up to date. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_TIMESTAMP = YES - -# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML -# documentation will contain a main index with vertical navigation menus that -# are dynamically created via JavaScript. If disabled, the navigation index will -# consists of multiple levels of tabs that are statically embedded in every HTML -# page. Disable this option to support browsers that do not have JavaScript, -# like the Qt help browser. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_MENUS = YES - -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the -# page has loaded. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_DYNAMIC_SECTIONS = NO - -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries -# shown in the various tree structured indices initially; the user can expand -# and collapse entries dynamically later on. Doxygen will expand the tree to -# such a level that at most the specified number of entries are visible (unless -# a fully collapsed tree already exceeds this amount). So setting the number of -# entries 1 will produce a full collapsed tree by default. 0 is a special value -# representing an infinite number of entries and will result in a full expanded -# tree by default. -# Minimum value: 0, maximum value: 9999, default value: 100. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_INDEX_NUM_ENTRIES = 100 - -# If the GENERATE_DOCSET tag is set to YES, additional index files will be -# generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: -# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To -# create a documentation set, doxygen will generate a Makefile in the HTML -# output directory. Running make will produce the docset in that directory and -# running make install will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy -# genXcode/_index.html for more information. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_DOCSET = NO - -# This tag determines the name of the docset feed. A documentation feed provides -# an umbrella under which multiple documentation sets from a single provider -# (such as a company or product suite) can be grouped. -# The default value is: Doxygen generated docs. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_FEEDNAME = "Doxygen generated docs" - -# This tag specifies a string that should uniquely identify the documentation -# set bundle. This should be a reverse domain-name style string, e.g. -# com.mycompany.MyDocSet. Doxygen will append .docset to the name. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_BUNDLE_ID = org.doxygen.Project - -# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify -# the documentation publisher. This should be a reverse domain-name style -# string, e.g. com.mycompany.MyDocSet.documentation. -# The default value is: org.doxygen.Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_ID = org.doxygen.Publisher - -# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. -# The default value is: Publisher. -# This tag requires that the tag GENERATE_DOCSET is set to YES. - -DOCSET_PUBLISHER_NAME = Publisher - -# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three -# additional HTML index files: index.hhp, index.hhc, and index.hhk. The -# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: -# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. -# -# The HTML Help Workshop contains a compiler that can convert all HTML output -# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML -# files are now used as the Windows 98 help format, and will replace the old -# Windows help format (.hlp) on all Windows platforms in the future. Compressed -# HTML files also contain an index, a table of contents, and you can search for -# words in the documentation. The HTML workshop also contains a viewer for -# compressed HTML files. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_HTMLHELP = NO - -# The CHM_FILE tag can be used to specify the file name of the resulting .chm -# file. You can add a path in front of the file if the result should not be -# written to the html output directory. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_FILE = - -# The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler (hhc.exe). If non-empty, -# doxygen will try to run the HTML help compiler on the generated index.hhp. -# The file has to be specified with full path. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -HHC_LOCATION = - -# The GENERATE_CHI flag controls if a separate .chi index file is generated -# (YES) or that it should be included in the main .chm file (NO). -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -GENERATE_CHI = NO - -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) -# and project file content. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -CHM_INDEX_ENCODING = - -# The BINARY_TOC flag controls whether a binary table of contents is generated -# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it -# enables the Previous and Next buttons. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members to -# the table of contents of the HTML help documentation and to the tree view. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTMLHELP is set to YES. - -TOC_EXPAND = NO - -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that -# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help -# (.qch) of the generated HTML documentation. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_QHP = NO - -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify -# the file name of the resulting .qch file. The path specified is relative to -# the HTML output folder. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QCH_FILE = - -# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help -# Project output. For more information please see Qt Help Project / Namespace -# (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_NAMESPACE = org.doxygen.Project - -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt -# Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). -# The default value is: doc. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_VIRTUAL_FOLDER = doc - -# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom -# filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_NAME = - -# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_CUST_FILTER_ATTRS = - -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's filter section matches. Qt Help Project / Filter Attributes (see: -# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHP_SECT_FILTER_ATTRS = - -# The QHG_LOCATION tag can be used to specify the location (absolute path -# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to -# run qhelpgenerator on the generated .qhp file. -# This tag requires that the tag GENERATE_QHP is set to YES. - -QHG_LOCATION = - -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be -# generated, together with the HTML files, they form an Eclipse help plugin. To -# install this plugin and make it available under the help contents menu in -# Eclipse, the contents of the directory containing the HTML and XML files needs -# to be copied into the plugins directory of eclipse. The name of the directory -# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. -# After copying Eclipse needs to be restarted before the help appears. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_ECLIPSEHELP = NO - -# A unique identifier for the Eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have this -# name. Each documentation set should have its own identifier. -# The default value is: org.doxygen.Project. -# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. - -ECLIPSE_DOC_ID = org.doxygen.Project - -# If you want full control over the layout of the generated HTML pages it might -# be necessary to disable the index and replace it with your own. The -# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top -# of each HTML page. A value of NO enables the index and the value YES disables -# it. Since the tabs in the index contain the same information as the navigation -# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -DISABLE_INDEX = NO - -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. If the tag -# value is set to YES, a side panel will be generated containing a tree-like -# index structure (just like the one that is generated for HTML Help). For this -# to work a browser that supports JavaScript, DHTML, CSS and frames is required -# (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can -# further fine-tune the look of the index. As an example, the default style -# sheet generated by doxygen has an example that shows how to put an image at -# the root of the tree instead of the PROJECT_NAME. Since the tree basically has -# the same information as the tab index, you could consider setting -# DISABLE_INDEX to YES when enabling this option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -GENERATE_TREEVIEW = YES - -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that -# doxygen will group on one line in the generated HTML documentation. -# -# Note that a value of 0 will completely suppress the enum values from appearing -# in the overview section. -# Minimum value: 0, maximum value: 20, default value: 4. -# This tag requires that the tag GENERATE_HTML is set to YES. - -ENUM_VALUES_PER_LINE = 4 - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used -# to set the initial width (in pixels) of the frame in which the tree is shown. -# Minimum value: 0, maximum value: 1500, default value: 250. -# This tag requires that the tag GENERATE_HTML is set to YES. - -TREEVIEW_WIDTH = 250 - -# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to -# external symbols imported via tag files in a separate window. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -EXT_LINKS_IN_WINDOW = NO - -# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg -# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see -# https://inkscape.org) to generate formulas as SVG images instead of PNGs for -# the HTML output. These images will generally look nicer at scaled resolutions. -# Possible values are: png (the default) and svg (looks nicer but requires the -# pdf2svg or inkscape tool). -# The default value is: png. -# This tag requires that the tag GENERATE_HTML is set to YES. - -HTML_FORMULA_FORMAT = png - -# Use this tag to change the font size of LaTeX formulas included as images in -# the HTML documentation. When you change the font size after a successful -# doxygen run you need to manually remove any form_*.png images from the HTML -# output directory to force them to be regenerated. -# Minimum value: 8, maximum value: 50, default value: 10. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_FONTSIZE = 10 - -# Use the FORMULA_TRANSPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are not -# supported properly for IE 6.0, but are supported on all modern browsers. -# -# Note that when changing this option you need to delete any form_*.png files in -# the HTML output directory before the changes have effect. -# The default value is: YES. -# This tag requires that the tag GENERATE_HTML is set to YES. - -FORMULA_TRANSPARENT = YES - -# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands -# to create new LaTeX commands to be used in formulas as building blocks. See -# the section "Including formulas" for details. - -FORMULA_MACROFILE = - -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# https://www.mathjax.org) which uses client side JavaScript for the rendering -# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX -# installed or if you want to formulas look prettier in the HTML output. When -# enabled you may also need to install MathJax separately and configure the path -# to it using the MATHJAX_RELPATH option. -# The default value is: NO. -# This tag requires that the tag GENERATE_HTML is set to YES. - -USE_MATHJAX = NO - -# When MathJax is enabled you can set the default output format to be used for -# the MathJax output. See the MathJax site (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. -# Possible values are: HTML-CSS (which is slower, but has the best -# compatibility), NativeMML (i.e. MathML) and SVG. -# The default value is: HTML-CSS. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_FORMAT = HTML-CSS - -# When MathJax is enabled you need to specify the location relative to the HTML -# output directory using the MATHJAX_RELPATH option. The destination directory -# should contain the MathJax.js script. For instance, if the mathjax directory -# is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax -# Content Delivery Network so you can quickly see the result without installing -# MathJax. However, it is strongly recommended to install a local copy of -# MathJax from https://www.mathjax.org before deployment. -# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_RELPATH = http://www.mathjax.org/mathjax - -# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax -# extension names that should be enabled during MathJax rendering. For example -# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_EXTENSIONS = - -# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces -# of code that will be used on startup of the MathJax code. See the MathJax site -# (see: -# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an -# example see the documentation. -# This tag requires that the tag USE_MATHJAX is set to YES. - -MATHJAX_CODEFILE = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box for -# the HTML output. The underlying search engine uses javascript and DHTML and -# should work on any modern browser. Note that when using HTML help -# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) -# there is already a search function so this one should typically be disabled. -# For large projects the javascript based search engine can be slow, then -# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to -# search using the keyboard; to jump to the search box use + S -# (what the is depends on the OS and browser, but it is typically -# , /