Qt/QtExamples
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Set the parameters for generating html (doxygen)

Browse Source
This commit is contained in:
xmuli 2021-03-08 15:54:46 +08:00
parent f0ddee7580
commit c3b2240343
No known key found for this signature in database
GPG Key ID: 7980604EB89EB1DF
1 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
CustomQch/Doxyfile
View File

@ -31,14 +31,15 @@ DOXYFILE_ENCODING = UTF-8
# project for which the documentation is generated. This name is used in 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. # title of most generated pages and in a few other places.
# The default value is: My Project. # The default value is: My Project.
# 生成文档的名称
PROJECT_NAME = "My Project" PROJECT_NAME = "My CustomQch"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This # 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 # could be handy for archiving the generated documentation or if some version
# control system is used. # control system is used.
# 项目文档的版本号码
PROJECT_NUMBER = PROJECT_NUMBER = 1.0.0
# Using the PROJECT_BRIEF tag one can provide an optional one line description # 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 # for a project that appears at the top of each page and should give viewer a
@ -57,8 +58,9 @@ PROJECT_LOGO =
# into which the generated documentation will be written. If a relative path is # 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 # entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used. # left blank the current directory will be used.
# 输出存放文档的路径
OUTPUT_DIRECTORY = OUTPUT_DIRECTORY = ./doc
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # 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 # directories (in 2 levels) under the output directory of each output format and
@ -90,8 +92,9 @@ ALLOW_UNICODE_NAMES = NO
# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
# Ukrainian and Vietnamese. # Ukrainian and Vietnamese.
# The default value is: English. # The default value is: English.
# 生成文档为中/英文 English
OUTPUT_LANGUAGE = English OUTPUT_LANGUAGE = Chinese
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # 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 # descriptions after the members that are listed in the file and class
@ -863,8 +866,9 @@ FILE_PATTERNS = *.c \
# The RECURSIVE tag can be used to specify whether or not subdirectories should # The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well. # be searched for input files as well.
# The default value is: NO. # The default value is: NO.
# 文件递归,包括子文件也要输出为文档
RECURSIVE = NO RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should be # 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 # excluded from the INPUT source files. This way you can easily exclude a
@ -925,8 +929,9 @@ EXAMPLE_RECURSIVE = NO
# The IMAGE_PATH tag can be used to specify one or more files or directories # 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 # that contain images that are to be included in the documentation (see the
# \image command). # \image command).
# 文档里面插入图片的存放路径
IMAGE_PATH = IMAGE_PATH = ./doc/images
# The INPUT_FILTER tag can be used to specify a program that doxygen should # 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 # invoke to filter for each input file. Doxygen will invoke the filter program