Skip to content

Commit 3c5ca87

Browse files
committed
doxygen: update config and Makefile, use same config for html and man
1 parent 303a3ec commit 3c5ca87

File tree

4 files changed

+71
-2629
lines changed

4 files changed

+71
-2629
lines changed

CMakeLists.txt

+36-8
Original file line numberDiff line numberDiff line change
@@ -673,23 +673,35 @@ if(BUILD_HTML_DOCUMENTATION OR BUILD_MAN_DOCUMENTATION)
673673
set(DOXYGEN_PROJECT_BRIEF "LAPACK: Linear Algebra PACKage")
674674
set(DOXYGEN_PROJECT_NUMBER ${LAPACK_VERSION})
675675
set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/DOCS)
676-
set(PROJECT_LOGO ${CMAKE_CURRENT_SOURCE_DIR}/DOCS/lapack.png)
676+
set(DOXYGEN_PROJECT_LOGO ${CMAKE_CURRENT_SOURCE_DIR}/DOCS/lapack.png)
677677
set(DOXYGEN_OPTIMIZE_FOR_FORTRAN YES)
678678
set(DOXYGEN_SOURCE_BROWSER YES)
679-
set(DISTRIBUTE_GROUP_DOC YES)
680679
set(DOXYGEN_CREATE_SUBDIRS YES)
681680
set(DOXYGEN_SEPARATE_MEMBER_PAGES YES)
682681
set(DOXYGEN_EXTRACT_ALL YES)
683-
set(DOXYGEN_FILE_PATTERNS "*.f;*.c;*.h")
682+
set(DOXYGEN_FILE_PATTERNS *.f *.f90 *.c *.h )
684683
set(DOXYGEN_RECURSIVE YES)
685684
set(DOXYGEN_GENERATE_TREEVIEW YES)
685+
set(DOXYGEN_DOT_IMAGE_FORMAT svg)
686686
set(DOXYGEN_INTERACTIVE_SVG YES)
687-
set(DOXYGEN_QUIET YES)
688-
set(DOXYGEN_WARNINGS NO)
687+
set(DOXYGEN_QUIET NO)
688+
set(DOXYGEN_WARNINGS YES)
689+
set(DOXYGEN_WARN_NO_PARAMDOC YES)
690+
set(DOXYGEN_WARN_LOGFILE doxygen_error)
689691
set(DOXYGEN_GENERATE_HTML NO)
690692
set(DOXYGEN_GENERATE_MAN NO)
691693

692694

695+
# Exclude functions that are duplicated, creating conflicts.
696+
set(DOXYGEN_EXCLUDE .git
697+
.github
698+
SRC/VARIANTS
699+
BLAS/SRC/lsame.f
700+
BLAS/SRC/xerbla.f
701+
BLAS/SRC/xerbla_array.f
702+
INSTALL/slamchf77.f
703+
INSTALL/dlamchf77.f )
704+
693705
if (BUILD_HTML_DOCUMENTATION)
694706
set(DOXYGEN_GENERATE_HTML YES)
695707
set(DOXYGEN_HTML_OUTPUT explore-html)
@@ -699,21 +711,37 @@ if(BUILD_HTML_DOCUMENTATION OR BUILD_MAN_DOCUMENTATION)
699711

700712
doxygen_add_docs(
701713
html
702-
${PROJECT_SOURCE_DIR}
714+
715+
# Doxygen INPUT =
716+
${PROJECT_SOURCE_DIR}/README.md
717+
${PROJECT_SOURCE_DIR}/BLAS
718+
${PROJECT_SOURCE_DIR}/CBLAS
719+
${PROJECT_SOURCE_DIR}/SRC
720+
${PROJECT_SOURCE_DIR}/INSTALL
721+
${PROJECT_SOURCE_DIR}/TESTING
722+
${PROJECT_SOURCE_DIR}/DOCS/groups-usr.dox
723+
703724
COMMENT "Generating html LAPACK documentation (it will take some time... time to grab a coffee)"
704725
)
705726
endif()
706727
if (BUILD_MAN_DOCUMENTATION)
707728
set(DOXYGEN_GENERATE_MAN YES)
708-
set(DOXYGEN_EXCLUDE SRC/VARIANTS)
709729
set(DOXYGEN_MAN_LINKS YES)
710730
set(DOXYGEN_INLINE_SOURCES NO)
711731
set(DOXYGEN_CALL_GRAPH NO)
712732
set(DOXYGEN_CALLER_GRAPH NO)
713733

714734
doxygen_add_docs(
715735
man
716-
${PROJECT_SOURCE_DIR}
736+
737+
# Doxygen INPUT =
738+
${PROJECT_SOURCE_DIR}/BLAS
739+
${PROJECT_SOURCE_DIR}/CBLAS
740+
${PROJECT_SOURCE_DIR}/SRC
741+
${PROJECT_SOURCE_DIR}/INSTALL
742+
${PROJECT_SOURCE_DIR}/TESTING
743+
${PROJECT_SOURCE_DIR}/DOCS/groups-usr.dox
744+
717745
COMMENT "Generating man LAPACK documentation"
718746
)
719747
endif()

DOCS/Doxyfile

+16-34
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,7 @@ IDL_PROPERTY_SUPPORT = YES
387387
# all members of a group must be documented explicitly.
388388
# The default value is: NO.
389389

390-
DISTRIBUTE_GROUP_DOC = YES
390+
DISTRIBUTE_GROUP_DOC = NO
391391

392392
# If one adds a struct or class to a group and this option is enabled, then also
393393
# any nested class or struct is added to the same group. By default this option
@@ -784,7 +784,7 @@ CITE_BIB_FILES =
784784
# messages are off.
785785
# The default value is: NO.
786786

787-
QUIET = YES
787+
QUIET = NO
788788

789789
# The WARNINGS tag can be used to turn on/off the warning messages that are
790790
# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
@@ -817,7 +817,7 @@ WARN_IF_DOC_ERROR = YES
817817
# EXTRACT_ALL is set to YES then this flag will automatically be disabled.
818818
# The default value is: NO.
819819

820-
WARN_NO_PARAMDOC = NO
820+
WARN_NO_PARAMDOC = YES
821821

822822
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
823823
# 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"
842842
# messages should be written. If left blank the output is written to standard
843843
# error (stderr).
844844

845-
WARN_LOGFILE = output_err
845+
WARN_LOGFILE = doxygen_error
846846

847847
#---------------------------------------------------------------------------
848848
# Configuration options related to the input files
@@ -854,8 +854,9 @@ WARN_LOGFILE = output_err
854854
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
855855
# Note: If this tag is empty the current directory is searched.
856856

857-
INPUT = . \
858-
DOCS/groups-usr.dox
857+
INPUT = BLAS CBLAS SRC INSTALL TESTING \
858+
DOCS/groups-usr.dox \
859+
README.md
859860

860861
# This tag can be used to specify the character encoding of the source files
861862
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -902,34 +903,15 @@ RECURSIVE = YES
902903
# Note that relative paths are relative to the directory from which doxygen is
903904
# run.
904905

905-
EXCLUDE = CMAKE \
906-
DOCS \
907-
.svn \
908-
CBLAS/.svn \
909-
CBLAS/src/.svn \
910-
CBLAS/testing/.svn \
911-
CBLAS/example/.svn \
912-
CBLAS/include/.svn \
913-
BLAS/.svn \
914-
BLAS/SRC/.svn \
915-
BLAS/TESTING/.svn \
916-
SRC/.svn \
917-
SRC/VARIANTS/.svn \
918-
SRC/VARIANTS/LIB/.svn \
919-
SRC/VARIANTS/cholesky/.svn \
920-
SRC/VARIANTS/cholesky/RL/.svn \
921-
SRC/VARIANTS/cholesky/TOP/.svn \
922-
SRC/VARIANTS/lu/.svn \
923-
SRC/VARIANTS/lu/CR/.svn \
924-
SRC/VARIANTS/lu/LL/.svn \
925-
SRC/VARIANTS/lu/REC/.svn \
926-
SRC/VARIANTS/qr/.svn \
927-
SRC/VARIANTS/qr/LL/.svn \
928-
INSTALL/.svn \
929-
TESTING/.svn \
930-
TESTING/EIG/.svn \
931-
TESTING/MATGEN/.svn \
932-
TESTING/LIN/.svn
906+
# Exclude functions that are duplicated, creating conflicts.
907+
EXCLUDE = .git \
908+
.github \
909+
SRC/VARIANTS \
910+
BLAS/SRC/lsame.f \
911+
BLAS/SRC/xerbla.f \
912+
BLAS/SRC/xerbla_array.f \
913+
INSTALL/slamchf77.f \
914+
INSTALL/dlamchf77.f \
933915

934916
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
935917
# directories that are symbolic links (a Unix file system feature) are excluded

0 commit comments

Comments
 (0)