我有一个成熟的Fortran代码,我想对其进行现代化改造,并作为此过程的一部分,在整个过程中包含doxygen注释。该代码包含头文件,其中包含变量(和以前常见的块(列表,然后可以将其包含在需要访问这些变量的子例程中。无论我做什么,我都无法获得doxygen(1.8.13(来处理这些文件。我写了一个更简单的例子,涉及下面的三个文件来说明我的意思:
模块.f
!> @brief An example of a module with global variables defined
!> @details The purpose is to explain why the global variables in group VARGROUP2 in the included file do not appear in the doxygen output.
!> @details Why? Please help! I can not see where I have made a mistake
MODULE EXAMPLE
INTEGER N
PARAMETRER(N=10)
!> @name VARGROUP1
!! Parameters in group 1
!> @{
DOUBLE PRECISION GR1_GLOBAL1 !< Example of a global variable
DOUBLE PRECISION GR1_GLOBAL2 !< Another example of a global variable
DOUBLE PRECISION GR1_VECTOR(N) !< An example of a global vector variable
!> @}
#include "VARIABLES.h"
!> @name VARGROUP3
!! Parameters in group 3
!> @{
DOUBLE PRECISION GR3_GLOBAL1 !< Example of a global variable
DOUBLE PRECISION GR3_GLOBAL2 !< Another example of a global variable
!> @}
CONTAINS
!> @brief An example of a subroutine within a module
!> @details A simple Hello World Program
SUBROUTINE EXSUB
INTEGER I !< Example of a local variable
I = 0
GR1_GLOBAL1 = 0
GR2_GLOBAL1 = 0
WRITE(*,*) 'HELLO WORLD'
WRITE(*,*) I,GR1_GLOBAL1,GR2_GLOBAL1
END SUBROUTINE EXSUB
END MODULE EXAMPLE
包含的头文件 (VARIABLES.h(:
!> @name VARGROUP2
!! Parameters in group 2
!> @{
DOUBLE PRECISION GR2_GLOBAL1 !< Example of a global variable
DOUBLE PRECISION GR2_GLOBAL2 !< Another example of a global variable
!> @}
为了完整起见,使用此模块的FORTRAN程序(PROG.f(:
PROGRAM PROG
USE EXAMPLE
CALL EXSUB
END
当我尝试对此进行修改时,HTML 输出成功显示VARGROUP1和VARGROUP3。但是,VARGROUP2(如 VARIABLES.h 文件中所定义(不存在。我在doxygen中尝试了许多选项,例如FORCE_LOCAL_INCLUDES
,ENABLE_PREPOSSESSING
,MACRO_EXPANSION
和SEARCH_INCLUDES
。
您能提供的任何帮助将不胜感激。
注意 我用 1.8.13(可以使用 apt-get 安装在 Ubuntu 18.04 中的版本(尝试了这一切。此后,我尝试了更新的版本(1.8.19(,但这会使事情变得更糟,因为现在没有出现任何变量组!
为了完整起见,以下是doxygen配置(由doxywizard生成(,考虑到Albert的评论:
# Doxyfile 1.8.13
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "Example which does not work"
PROJECT_NUMBER =
PROJECT_BRIEF =
PROJECT_LOGO =
OUTPUT_DIRECTORY = /home/USER/SCRATCH/OFFICIAL_CHANGE/TEST/doxytest/OUTPUT
CREATE_SUBDIRS = NO
ALLOW_UNICODE_NAMES = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class"
"The $name widget"
"The $name file"
is
provides
specifies
contains
represents
a
an
the
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4
ALIASES =
TCL_SUBST =
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
OPTIMIZE_FOR_FORTRAN = YES
OPTIMIZE_OUTPUT_VHDL = NO
EXTENSION_MAPPING = "EXTENSION_MAPPING= .h=fortran"
MARKDOWN_SUPPORT = YES
TOC_INCLUDE_HEADINGS = 0
AUTOLINK_SUPPORT = YES
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
IDL_PROPERTY_SUPPORT = YES
DISTRIBUTE_GROUP_DOC = NO
GROUP_NESTED_COMPOUNDS = NO
SUBGROUPING = YES
INLINE_GROUPED_CLASSES = NO
INLINE_SIMPLE_STRUCTS = NO
TYPEDEF_HIDES_STRUCT = NO
LOOKUP_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_PACKAGE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = YES
EXTRACT_ANON_NSPACES = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = YES
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
HIDE_COMPOUND_REFERENCE= NO
SHOW_INCLUDE_FILES = YES
SHOW_GROUPED_MEMB_INC = YES
FORCE_LOCAL_INCLUDES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = YES
SORT_MEMBERS_CTORS_1ST = YES
SORT_GROUP_NAMES = YES
SORT_BY_SCOPE_NAME = YES
STRICT_PROTO_MATCHING = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_FILES = YES
SHOW_NAMESPACES = YES
FILE_VERSION_FILTER =
LAYOUT_FILE =
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_AS_ERROR = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = /home/USER/SCRATCH/OFFICIAL_CHANGE/TEST/doxytest
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.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
*.py
*.pyw
*.f90
*.f95
*.f03
*.f08
*.f
*.for
*.tcl
*.vhd
*.vhdl
*.ucf
*.qsf
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE =
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = YES
INLINE_SOURCES = YES
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
SOURCE_TOOLTIPS = YES
USE_HTAGS = YES
VERBATIM_HEADERS = YES
CLANG_ASSISTED_PARSING = NO
CLANG_OPTIONS =
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET =
HTML_EXTRA_FILES =
HTML_COLORSTYLE_HUE = 220
HTML_COLORSTYLE_SAT = 100
HTML_COLORSTYLE_GAMMA = 80
HTML_TIMESTAMP = NO
HTML_DYNAMIC_SECTIONS = NO
HTML_INDEX_NUM_ENTRIES = 100
GENERATE_DOCSET = NO
DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
DOCSET_PUBLISHER_NAME = Publisher
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
CHM_INDEX_ENCODING =
BINARY_TOC = NO
TOC_EXPAND = NO
GENERATE_QHP = NO
QCH_FILE =
QHP_NAMESPACE = org.doxygen.Project
QHP_VIRTUAL_FOLDER = doc
QHP_CUST_FILTER_NAME =
QHP_CUST_FILTER_ATTRS =
QHP_SECT_FILTER_ATTRS =
QHG_LOCATION =
GENERATE_ECLIPSEHELP = NO
ECLIPSE_DOC_ID = org.doxygen.Project
DISABLE_INDEX = NO
GENERATE_TREEVIEW = NO
ENUM_VALUES_PER_LINE = 4
TREEVIEW_WIDTH = 250
EXT_LINKS_IN_WINDOW = NO
FORMULA_FONTSIZE = 10
FORMULA_TRANSPARENT = YES
USE_MATHJAX = NO
MATHJAX_FORMAT = HTML-CSS
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
MATHJAX_EXTENSIONS =
MATHJAX_CODEFILE =
SEARCHENGINE = YES
SERVER_BASED_SEARCH = NO
EXTERNAL_SEARCH = NO
SEARCHENGINE_URL =
SEARCHDATA_FILE = searchdata.xml
EXTERNAL_SEARCH_ID =
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = YES
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4
EXTRA_PACKAGES =
LATEX_HEADER =
LATEX_FOOTER =
LATEX_EXTRA_STYLESHEET =
LATEX_EXTRA_FILES =
PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
LATEX_SOURCE_CODE = NO
LATEX_BIB_STYLE = plain
LATEX_TIMESTAMP = NO
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
RTF_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_SUBDIR =
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
GENERATE_DOCBOOK = NO
DOCBOOK_OUTPUT = docbook
DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
EXTERNAL_PAGES = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = NO
MSCGEN_PATH =
DIA_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
DOT_NUM_THREADS = 0
DOT_FONTNAME = Helvetica
DOT_FONTSIZE = 10
DOT_FONTPATH =
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
UML_LIMIT_NUM_FIELDS = 10
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
INTERACTIVE_SVG = NO
DOT_PATH =
DOTFILE_DIRS =
MSCFILE_DIRS =
DIAFILE_DIRS =
PLANTUML_JAR_PATH =
PLANTUML_CFG_FILE =
PLANTUML_INCLUDE_PATH =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
感谢 Albert 的所有投入。我现在能够对我的问题提出答案,并总结我哪里出错了。
问题在于,尽管最初发布的代码从编译器的角度来看是正确的,但 Doxygen 希望每个文件都是函数、子例程、模块或主文件。因此,为了"欺骗"Doxygen认为代码是有效的,可以使用几个 #ifdef 语句来使Doxygen看起来它是一个模块(参见下面的VARIABLES.h(。请注意,从编译器的角度来看,它不会被愚弄,也不会将头文件的内容分类为模块。
另一个需要的更改是Doxygen的配置,因为.h文件将作为C头文件处理。因此,需要扩展映射来重新定义所有要成为 fortran 的 .h 文件(请参阅下面的 doxywizard 配置输出(。
这三个文件现在如下:
!> @brief An example of a module with global variables defined
!> @details The purpose is to explain why the global variables in group VARGROUP2 in the included file do not appear in the DOXYGEN ouptut.
!> @details Why? Please help! I can not see where I have made a mistake
!> @details I added the suggestion made by Albert and also renamed the header file to a fortran F file
MODULE EXAMPLE
INTEGER N !< Size of vector
PARAMETER(N=10)
!> @name VARGROUP1
!! Parameters in group 1
DOUBLE PRECISION GR1_GLOBAL1 !< Example of a global variable
DOUBLE PRECISION GR1_GLOBAL2 !< Another example of a global variable
DOUBLE PRECISION GR1_VECTOR(N) !< An example of a global vector variable
!> @}
#include "VARIABLES.h"
!> @name VARGROUP3
!! Parameters in group 3
DOUBLE PRECISION GR3_GLOBAL1 !< Example of a global variable
DOUBLE PRECISION GR3_GLOBAL2 !< Another example of a global variable
!> @}
CONTAINS
!> @brief An example of a subroutine within a module
!> @details A simple Hello World Program
SUBROUTINE EXSUB
INTEGER I !< Example of a local variable
I = 0
GR1_GLOBAL1 = 1
GR2_GLOBAL1 = 2
GR3_GLOBAL1 = 3
WRITE(*,*) 'HELLO WORLD'
WRITE(*,*) I,GR1_GLOBAL1,GR2_GLOBAL1,GR3_GLOBAL1
END SUBROUTINE EXSUB
END MODULE EXAMPLE
包含的文件的内容如下 (VARIABLES.h(。#ifdef 构造是重要的位:
#ifdef DOXYGEN
MODULE VARGROUP2
#endif
!> @name VARGROUP2
!! Parameters in group 2
!> @{
DOUBLE PRECISION GR2_GLOBAL1 !< Example of a global variable
DOUBLE PRECISION GR2_GLOBAL2 !< Another example of a global variable
!> @}
#ifdef DOXYGEN
END
#endif
为了完整起见,使用 EXAMPLE 模块并创建程序的 FORTRAN 代码如下所示:
PROGRAM PROG
USE EXAMPLE
CALL EXSUB
END
此外,doxygen配置(由doxywizard输出(如下,注意需要使用扩展映射来强制doxygen认为.h文件包含fortran代码:
# Doxyfile 1.8.13
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
DOXYFILE_ENCODING = UTF-8
PROJECT_NAME = "Example Module"
PROJECT_NUMBER =
PROJECT_BRIEF =
PROJECT_LOGO =
OUTPUT_DIRECTORY = /home/rwhg1/SCRATCH/OFFICIAL_CHANGE/TEST/doxytest
CREATE_SUBDIRS = NO
ALLOW_UNICODE_NAMES = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class"
"The $name widget"
"The $name file"
is
provides
specifies
contains
represents
a
an
the
ALWAYS_DETAILED_SEC = NO
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = NO
QT_AUTOBRIEF = NO
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 4
ALIASES =
TCL_SUBST =
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
OPTIMIZE_FOR_FORTRAN = YES
OPTIMIZE_OUTPUT_VHDL = NO
EXTENSION_MAPPING = f=FortranFixed
h=FortranFixed
MARKDOWN_SUPPORT = YES
TOC_INCLUDE_HEADINGS = 0
AUTOLINK_SUPPORT = YES
BUILTIN_STL_SUPPORT = NO
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
IDL_PROPERTY_SUPPORT = YES
DISTRIBUTE_GROUP_DOC = NO
GROUP_NESTED_COMPOUNDS = NO
SUBGROUPING = YES
INLINE_GROUPED_CLASSES = NO
INLINE_SIMPLE_STRUCTS = NO
TYPEDEF_HIDES_STRUCT = NO
LOOKUP_CACHE_SIZE = 0
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_PACKAGE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = YES
EXTRACT_ANON_NSPACES = YES
HIDE_UNDOC_MEMBERS = YES
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = NO
HIDE_SCOPE_NAMES = NO
HIDE_COMPOUND_REFERENCE= NO
SHOW_INCLUDE_FILES = YES
SHOW_GROUPED_MEMB_INC = YES
FORCE_LOCAL_INCLUDES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
SORT_MEMBERS_CTORS_1ST = NO
SORT_GROUP_NAMES = NO
SORT_BY_SCOPE_NAME = NO
STRICT_PROTO_MATCHING = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
SHOW_FILES = YES
SHOW_NAMESPACES = YES
FILE_VERSION_FILTER =
LAYOUT_FILE =
CITE_BIB_FILES =
#---------------------------------------------------------------------------
# Configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_AS_ERROR = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# Configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = /home/rwhg1/SCRATCH/OFFICIAL_CHANGE/TEST/doxytest
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.f
*.for
*.h
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
EXCLUDE_SYMBOLS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS = *.f
*.for
*..h
FILTER_SOURCE_FILES = NO
FILTER_SOURCE_PATTERNS =
USE_MDFILE_AS_MAINPAGE =
#---------------------------------------------------------------------------
# Configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = NO
INLINE_SOURCES = YES
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
SOURCE_TOOLTIPS = YES
USE_HTAGS = NO
VERBATIM_HEADERS = YES
CLANG_ASSISTED_PARSING = NO
CLANG_OPTIONS =
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_EXTRA_STYLESHEET =
HTML_EXTRA_FILES =
HTML_COLORSTYLE_HUE = 220
HTML_COLORSTYLE_SAT = 100
HTML_COLORSTYLE_GAMMA = 80
HTML_TIMESTAMP = NO
HTML_DYNAMIC_SECTIONS = NO
HTML_INDEX_NUM_ENTRIES = 100
GENERATE_DOCSET = NO
DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
DOCSET_PUBLISHER_NAME = Publisher
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
CHM_INDEX_ENCODING =
BINARY_TOC = NO
TOC_EXPAND = NO
GENERATE_QHP = NO
QCH_FILE =
QHP_NAMESPACE = org.doxygen.Project
QHP_VIRTUAL_FOLDER = doc
QHP_CUST_FILTER_NAME =
QHP_CUST_FILTER_ATTRS =
QHP_SECT_FILTER_ATTRS =
QHG_LOCATION =
GENERATE_ECLIPSEHELP = NO
ECLIPSE_DOC_ID = org.doxygen.Project
DISABLE_INDEX = NO
GENERATE_TREEVIEW = YES
ENUM_VALUES_PER_LINE = 4
TREEVIEW_WIDTH = 250
EXT_LINKS_IN_WINDOW = NO
FORMULA_FONTSIZE = 10
FORMULA_TRANSPARENT = YES
USE_MATHJAX = NO
MATHJAX_FORMAT = HTML-CSS
MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
MATHJAX_EXTENSIONS =
MATHJAX_CODEFILE =
SEARCHENGINE = YES
SERVER_BASED_SEARCH = NO
EXTERNAL_SEARCH = NO
SEARCHENGINE_URL =
SEARCHDATA_FILE = searchdata.xml
EXTERNAL_SEARCH_ID =
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = YES
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4
EXTRA_PACKAGES =
LATEX_HEADER =
LATEX_FOOTER =
LATEX_EXTRA_STYLESHEET =
LATEX_EXTRA_FILES =
PDF_HYPERLINKS = YES
USE_PDFLATEX = YES
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
LATEX_SOURCE_CODE = NO
LATEX_BIB_STYLE = plain
LATEX_TIMESTAMP = NO
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
RTF_SOURCE_CODE = NO
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_SUBDIR =
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
XML_OUTPUT = xml
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
GENERATE_DOCBOOK = NO
DOCBOOK_OUTPUT = docbook
DOCBOOK_PROGRAMLISTING = NO
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = NO
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
EXTERNAL_PAGES = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = NO
MSCGEN_PATH =
DIA_PATH =
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
DOT_NUM_THREADS = 0
DOT_FONTNAME = Helvetica
DOT_FONTSIZE = 10
DOT_FONTPATH =
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
UML_LIMIT_NUM_FIELDS = 10
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = YES
CALLER_GRAPH = YES
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
INTERACTIVE_SVG = NO
DOT_PATH = /usr/bin/dot
DOTFILE_DIRS =
MSCFILE_DIRS =
DIAFILE_DIRS =
PLANTUML_JAR_PATH =
PLANTUML_CFG_FILE =
PLANTUML_INCLUDE_PATH =
DOT_GRAPH_MAX_NODES = 50
MAX_DOT_GRAPH_DEPTH = 0
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
Doxygen 生成的 HTML 输出将头文件的内容显示为模块,这显然是不正确的。希望这种解决方法足够好,但如果有人有更好的解决方案,我全听!
最后,我选择编写一个FORTRAN程序,该程序预处理DOXYGEN要处理的FORTRAN文件。该程序的目的是将 #include"filename.xxx"的所有实例替换为 filename.xxx 的内容。最初,这用于确保正确处理头文件的内容(无需设置"假"模块来包含变量(。但是,将功能描述(即@brief和@details卡(分开也很有用,因为其中一些很长!无论如何,我认为这可能对社区有用(使用风险自负(:
!> @brief A program that inserts all included files into a FORTRAN input file
!> @details Requires two inputs:
!> @details 1/. the FORTRAN input file containing '#include' directives
!> @details 2./ the output filename for the new FORTRAN input file
PROGRAM MAIN
IMPLICIT NONE
CHARACTER*1000 ARG1,ARG2,INCFILE
CHARACTER*90000 BUFFER
LOGICAL YESNO
INTEGER CONT,IE,COUNTER
! **** Get original FORTRAN file to which included files to be added
CALL GETARG(1,ARG1)
! **** Get name of new FORTRAN file
CALL GETARG(2,ARG2)
C **** Check file exists already
INQUIRE(FILE=ARG1,EXIST=YESNO)
IF(YESNO) THEN
OPEN(10,FILE=ARG1,STATUS='OLD')
ELSE
STOP
ENDIF
C **** Check output file does not exist
INQUIRE(FILE=ARG2,EXIST=YESNO)
IF(YESNO) THEN
WRITE(*,'(A)') 'OUTPUT FILE ALREADY EXISTS'
STOP
ENDIF
OPEN(20,FILE=ARG2,STATUS='NEW')
C **** Loop through input file. If pre-processor directive
C '#include' exists, then call INSERTINCLUDE. If not then simply
C copy the line to the output file
CONT = 0
COUNTER = 20
DO WHILE(CONT.GE.0)
READ(10,'(A)',END=999) BUFFER
IF(BUFFER(1:8).EQ.'#include') THEN
COUNTER = COUNTER + 1
CALL INSERTINCLUDE(BUFFER,COUNTER)
ELSE
WRITE(20,'(A)') TRIM(BUFFER)
ENDIF
ENDDO
999 CONTINUE
CLOSE(10)
CLOSE(20)
END
!> @brief A recursive subroutine which replaces an '#include' line with the contents of the file being referenced
!> @details Subroutine is recursive so can include files that are included within another included file
!> @details Useful to keep lengthy Doxygen comments separate from the actual code aswell
RECURSIVE SUBROUTINE INSERTINCLUDE(BUFFER,COUNTER)
IMPLICIT NONE
CHARACTER*90000 BUFFER !> A character buffer which is hopefully large enough to hold the contents of each line in the included file (also initially contains the '#include' line with the file to be opened)
CHARACTER*1000 INCFILE !> Included file to be opened
INTEGER COUNTER !> A unique LUN number for the included file which increments by 1 for every recursive instance of this subroutine
INTEGER IE,CONT2,NEXTCOUNTER
LOGICAL YESNO
C **** DETERMINE THE DOUBLE QUOTATION MARKS SURROUNDING THE FILE TO BE INCLUDED
WRITE(*,'(A)') TRIM(BUFFER)
IE = INDEX(BUFFER,'"')
INCFILE = BUFFER(IE+1:)
IE = INDEX(INCFILE,'"')
INCFILE = INCFILE(1:IE-1)
WRITE(*,'(2A)') 'INCLUDING ',TRIM(INCFILE)
C **** CHECK THE FILE TO BE INCLUDED EXISTS. IF YES THEN OPEN
INQUIRE(FILE=INCFILE,EXIST=YESNO)
IF(YESNO) THEN
OPEN(COUNTER,FILE=INCFILE,STATUS='OLD')
ELSE
WRITE(*,'(A)') 'COULD NOT OPEN INCLUDE FILE'
STOP
ENDIF
C **** LOOP THROUGH THE INCLUDED FILE AND COPY CONTENTS TO LUN 20 (I.E. THE MAIN OUTPUT FILE)
C IF ANOTHER '#include' IS FOUND THEN RUN ANOTHER INSTANCE OF THIS SUBROUTINE
CONT2 = 0
DO WHILE(CONT2.GE.0)
READ(COUNTER,'(A)',END=888) BUFFER
IF(BUFFER(1:8).EQ.'#include') THEN
NEXTCOUNTER = COUNTER + 1
CALL INSERTINCLUDE(BUFFER,NEXTCOUNTER)
ELSE
WRITE(20,'(A)') TRIM(BUFFER)
ENDIF
ENDDO
888 WRITE(*,'(2A)') 'FINISHED INCLUDING ',TRIM(INCFILE)
CLOSE(COUNTER)
END
毫无疑问,可能有一种更简单的方法,但这对我有用。