summaryrefslogtreecommitdiff
path: root/DOCS
diff options
context:
space:
mode:
authorJulie <julie@cs.utk.edu>2016-09-15 22:07:11 -0700
committerJulie <julie@cs.utk.edu>2016-09-15 22:15:55 -0700
commit843115bbda74bc27b8e0dfa8abd275d7c4522707 (patch)
tree708c2c360865091178f24b6cc7eb559ea7ff09e6 /DOCS
parent9e6bfe88acd54561d987c973671dea74c804d0ab (diff)
downloadlapack-843115bbda74bc27b8e0dfa8abd275d7c4522707.tar.gz
lapack-843115bbda74bc27b8e0dfa8abd275d7c4522707.tar.bz2
lapack-843115bbda74bc27b8e0dfa8abd275d7c4522707.zip
Fix issue #8 reported by @matzeri on July 21st 2016
Issue was due to missing Doxygen group, and other Doxygen Group related issue
Diffstat (limited to 'DOCS')
-rw-r--r--DOCS/Doxyfile_man62
-rw-r--r--DOCS/groups-usr.dox115
2 files changed, 134 insertions, 43 deletions
diff --git a/DOCS/Doxyfile_man b/DOCS/Doxyfile_man
index da642c4b..09e87f2c 100644
--- a/DOCS/Doxyfile_man
+++ b/DOCS/Doxyfile_man
@@ -38,7 +38,7 @@ PROJECT_NAME = LAPACK
# could be handy for archiving the generated documentation or if some version
# control system is used.
-PROJECT_NUMBER = 3.6.0
+PROJECT_NUMBER = 3.6.1
# 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
@@ -705,7 +705,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
@@ -810,32 +810,12 @@ RECURSIVE = YES
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
+ 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
@@ -959,7 +939,7 @@ SOURCE_BROWSER = YES
# classes and enums directly into the documentation.
# The default value is: NO.
-INLINE_SOURCES = YES
+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
@@ -2164,7 +2144,7 @@ HIDE_UNDOC_RELATIONS = YES
# set to NO
# The default value is: NO.
-HAVE_DOT = YES
+HAVE_DOT = NO
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
@@ -2206,7 +2186,7 @@ DOT_FONTPATH =
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
-CLASS_GRAPH = YES
+CLASS_GRAPH = NO
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation
@@ -2215,14 +2195,14 @@ CLASS_GRAPH = YES
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
-COLLABORATION_GRAPH = YES
+COLLABORATION_GRAPH = NO
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
-GROUP_GRAPHS = YES
+GROUP_GRAPHS = NO
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
@@ -2260,7 +2240,7 @@ TEMPLATE_RELATIONS = NO
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
-INCLUDE_GRAPH = YES
+INCLUDE_GRAPH = NO
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# set to YES then doxygen will generate a graph for each documented file showing
@@ -2269,7 +2249,7 @@ INCLUDE_GRAPH = YES
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
-INCLUDED_BY_GRAPH = YES
+INCLUDED_BY_GRAPH = NO
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
# dependency graph for every global function or class method.
@@ -2281,7 +2261,7 @@ INCLUDED_BY_GRAPH = YES
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
-CALL_GRAPH = YES
+CALL_GRAPH = NO
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method.
@@ -2293,14 +2273,14 @@ CALL_GRAPH = YES
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
-CALLER_GRAPH = YES
+CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
-GRAPHICAL_HIERARCHY = YES
+GRAPHICAL_HIERARCHY = NO
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# dependencies a directory has on other directories in a graphical way. The
@@ -2309,7 +2289,7 @@ GRAPHICAL_HIERARCHY = YES
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
-DIRECTORY_GRAPH = YES
+DIRECTORY_GRAPH = NO
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. For an explanation of the image formats see the section
@@ -2336,7 +2316,7 @@ DOT_IMAGE_FORMAT = svg
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
-INTERACTIVE_SVG = YES
+INTERACTIVE_SVG = NO
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
@@ -2427,7 +2407,7 @@ DOT_MULTI_TARGETS = NO
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
-GENERATE_LEGEND = YES
+GENERATE_LEGEND = NO
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
# files that are used to generate the various graphs.
diff --git a/DOCS/groups-usr.dox b/DOCS/groups-usr.dox
index feb134f1..63556ef8 100644
--- a/DOCS/groups-usr.dox
+++ b/DOCS/groups-usr.dox
@@ -14,6 +14,9 @@
* @defgroup SY Symmetric Matrix
* @ingroup lapack
* This is the group of Symmetric Matrix routines
+ * @defgroup HE Hermitian Matrix
+ * @ingroup lapack
+ * This is the group of Hermitian Matrix routines
* @defgroup PO Positive Definite Matrix
* @ingroup lapack
* This is the group of Positive Definite routines
@@ -23,9 +26,18 @@
* @defgroup PT Positive Definite tridiagonal Matrix
* @ingroup lapack
* This is the group of Positive Definite tridiagonal routines
- * @defgroup auxOTHERauxiliary Other Auxiliary Routines
+ * @defgroup OTHEReigen Eigenvalue
+ * @ingroup lapack
+ * This is the group of Other Eigenvalue routines
+ * @defgroup OTHERauxiliary Other Auxiliary Routines
* @ingroup lapack
* This is the group of Other Auxiliary routines
+ * @defgroup OTHERcomputational Other Computational Routines
+ * @ingroup lapack
+ * This is the group of Other Computational routines
+ * @defgroup OTHERsolve Other Solve Routines
+ * @ingroup lapack
+ * This is the group of Other Solve routines
*
****
*
@@ -38,6 +50,9 @@
* @defgroup solveSY Linear Solve
* @ingroup SY
* This is the group of Linear Solve Driver routines
+ * @defgroup solveHE Linear Solve
+ * @ingroup HE
+ * This is the group of Linear Solve Driver routines
* @defgroup solvePO Linear Solve
* @ingroup PO
* This is the group of Linear Solve Driver routines
@@ -53,27 +68,42 @@
* @defgroup eigenSY Eigenvalue
* @ingroup SY
* This is the group of Eigenvalue Driver routines
+ * @defgroup eigenHE Eigenvalue
+ * @ingroup HE
+ * This is the group of Eigenvalue Driver routines
* @defgroup singGE Singular Value
* @ingroup GE
* This is the group of Singular Value Driver routines
* @defgroup computationalGE Computational routines
* @ingroup GE
* This is the group of Computational routines
+ * @defgroup variantsGEcomputational Variants Computational routines
+ * @ingroup GE
+ * This is the group of Variants Computational routines
* @defgroup computationalGB Computational routines
* @ingroup GB
* This is the group of Computational routines
* @defgroup computationalSY Computational routines
* @ingroup SY
* This is the group of Computational routines
+ * @defgroup computationalHE Computational routines
+ * @ingroup HE
+ * This is the group of Computational routines
* @defgroup computationalPO Computational routines
* @ingroup PO
* This is the group of Computational routines
+ * @defgroup variantsPOcomputational Variants Computational routines
+ * @ingroup PO
+ * This is the group of Variants Computational routines
* @defgroup computationalGT Computational routines
* @ingroup GT
* This is the group of Computational routines
* @defgroup computationalPT Computational routines
* @ingroup PT
* This is the group of Computational routines
+ * @defgroup variantsOTHERcomputational Variants Computational routines
+ * @ingroup OTHERcomputational
+ * This is the group of Variants Computational routines
* @defgroup auxiliaryGE Auxiliary routines
* @ingroup GE
* This is the group of Auxiliary routines
@@ -83,6 +113,9 @@
* @defgroup auxiliarySY Auxiliary routines
* @ingroup SY
* This is the group of Auxiliary routines
+ * @defgroup auxiliaryHE Auxiliary routines
+ * @ingroup HE
+ * This is the group of Auxiliary routines
* @defgroup auxiliaryPO Auxiliary routines
* @ingroup PO
* This is the group of Auxiliary routines
@@ -158,6 +191,18 @@
* @defgroup doubleGTauxiliary double
* @ingroup auxiliaryGT
* This is the group of double auxiliary functions for GT matrices
+ * @defgroup doubleOTHERauxiliary double
+ * @ingroup OTHERauxiliary
+ * This is the group of double other auxiliary routines
+ * @defgroup doubleOTHERcomputational double
+ * @ingroup OTHERcomputational
+ * This is the group of double other Computational routines
+ * @defgroup doubleOTHERsolve double Other Solve Routines
+ * @ingroup OTHERsolve
+ * This is the group of double Other Solve routines
+ * @defgroup doubleOTHEReigen double
+ * @ingroup OTHEReigen
+ * This is the group of double Other Eigenvalue routines
*
****
*
@@ -224,6 +269,18 @@
* @defgroup realPTauxiliary real
* @ingroup auxiliaryPT
* This is the group of real auxiliary functions for PT matrices
+ * @defgroup realOTHERauxiliary real
+ * @ingroup OTHERauxiliary
+ * This is the group of real other auxiliary routines
+ * @defgroup realOTHERcomputational real
+ * @ingroup OTHERcomputational
+ * This is the group of real other Computational routines
+ * @defgroup realOTHERsolve real Other Solve Routines
+ * @ingroup OTHERsolve
+ * This is the group of real Other Solve routines
+ * @defgroup realOTHEReigen real
+ * @ingroup OTHEReigen
+ * This is the group of real Other Eigenvalue routines
*
****
*
@@ -236,6 +293,9 @@
* @defgroup complexSYsolve complex
* @ingroup solveSY
* This is the group of complex solve driver functions for SY matrices
+ * @defgroup complexHEsolve complex
+ * @ingroup solveHE
+ * This is the group of complex solve driver functions for HE matrices
* @defgroup complexGBsolve complex
* @ingroup solveGB
* This is the group of complex solve driver functions for GB matrices
@@ -251,6 +311,9 @@
* @defgroup complexSYeigen complex
* @ingroup eigenSY
* This is the group of complex eigenvalue driver functions for SY matrices
+ * @defgroup complexHEeigen complex
+ * @ingroup eigenHE
+ * This is the group of complex eigenvalue driver functions for HE matrices
* @defgroup complexGEsing complex
* @ingroup singGE
* This is the group of complex singular value driver functions for GE matrices
@@ -263,6 +326,9 @@
* @defgroup complexSYcomputational complex
* @ingroup computationalSY
* This is the group of complex computational functions for SY matrices
+ * @defgroup complexHEcomputational complex
+ * @ingroup computationalHE
+ * This is the group of complex computational functions for HE matrices
* @defgroup complexGBcomputational complex
* @ingroup computationalGB
* This is the group of complex computational functions for GB matrices
@@ -281,9 +347,24 @@
* @defgroup complexSYauxiliary complex
* @ingroup auxiliarySY
* This is the group of complex auxiliary functions for SY matrices
+ * @defgroup complexHEauxiliary complex
+ * @ingroup auxiliaryHE
+ * This is the group of complex auxiliary functions for HE matrices
* @defgroup complexGBauxiliary complex
* @ingroup auxiliaryGB
* This is the group of complex auxiliary functions for GB matrices
+ * @defgroup complexOTHERauxiliary complex
+ * @ingroup OTHERauxiliary
+ * This is the group of complex other auxiliary routines
+ * @defgroup complexOTHERcomputational complex
+ * @ingroup OTHERcomputational
+ * This is the group of complex other Computational routines
+ * @defgroup complexOTHERsolve complex Other Solve Routines
+ * @ingroup OTHERsolve
+ * This is the group of complex Other Solve routines
+ * @defgroup complexOTHEReigen complex Other Eigenvalue routines
+ * @ingroup OTHEReigen
+ * This is the group of complex Other Eigenvalue routines
*
****
*
@@ -296,6 +377,9 @@
* @defgroup complex16SYsolve complex16
* @ingroup solveSY
* This is the group of complex16 solve driver functions for SY matrices
+ * @defgroup complex16HEsolve complex16
+ * @ingroup solveHE
+ * This is the group of complex16 solve driver functions for HE matrices
* @defgroup complex16GBsolve complex16
* @ingroup solveGB
* This is the group of complex16 solve driver functions for GB matrices
@@ -311,6 +395,9 @@
* @defgroup complex16SYeigen complex16
* @ingroup eigenSY
* This is the group of complex16 eigenvalue driver functions for SY matrices
+ * @defgroup complex16HEeigen complex16
+ * @ingroup eigenHE
+ * This is the group of complex16 eigenvalue driver functions for HE matrices
* @defgroup complex16GEsing complex16
* @ingroup singGE
* This is the group of complex16 singular value driver functions for GE matrices
@@ -323,6 +410,9 @@
* @defgroup complex16SYcomputational complex16
* @ingroup computationalSY
* This is the group of complex16 computational functions for SY matrices
+ * @defgroup complex16HEcomputational complex16
+ * @ingroup computationalHE
+ * This is the group of complex16 computational functions for HE matrices
* @defgroup complex16GBcomputational complex16
* @ingroup computationalGB
* This is the group of complex16 computational functions for GB matrices
@@ -341,9 +431,27 @@
* @defgroup complex16SYauxiliary complex16
* @ingroup auxiliarySY
* This is the group of complex16 auxiliary functions for SY matrices
+ * @defgroup complex16HEauxiliary complex16
+ * @ingroup auxiliaryHE
+ * This is the group of complex16 auxiliary functions for HE matrices
* @defgroup complex16GBauxiliary complex16
* @ingroup auxiliaryGB
* This is the group of complex16 auxiliary functions for GB matrices
+ * @defgroup complex16OTHERcomputational complex16
+ * @ingroup OTHERcomputational
+ * This is the group of complex16 other Computational routines
+ * @defgroup complex16OTHERauxiliary complex16
+ * @ingroup OTHERauxiliary
+ * This is the group of complex16 other auxiliary routines
+ * @defgroup auxOTHERcomputational auxiliary Computational routines
+ * @ingroup OTHERcomputational
+ * This is the group of auxiliary Computational routines
+ * @defgroup complex16OTHERsolve complex16 Other Solve Routines
+ * @ingroup OTHERsolve
+ * This is the group of complex16 Other Solve routines
+ * @defgroup complex16OTHEReigen complex16 Other Eigenvalue routines
+ * @ingroup OTHEReigen
+ * This is the group of complex16 Other Eigenvalue routines
*
****
*
@@ -435,7 +543,10 @@
* @defgroup level3 Level3
* @ingroup blas
* This is the group of LEVEL 3 BLAS routines.
- * @defgroup blastesting Testing
+ * @defgroup aux_blas Auxiliary BLAS
+ * @ingroup blas
+ * This is the group of Auxiliary 3 BLAS routines.
+* @defgroup blastesting Testing
* @ingroup blas
* This is the group of BLAS TESTING routines.
*