chris/OSCAR-code
1
0
Fork 0
mirror of https://gitlab.com/pholy/OSCAR-code.git synced 2025-04-07 11:40:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Doxyfile to run from oscar-code and place output in doxydoc directory, and ignore doxydoc in .gitignore.

Browse Source
This commit is contained in:
Seeker4 2019-05-06 18:01:19 -07:00
parent 817d5603c1
commit f3ba9747fd
2 changed files with 24 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@ -44,3 +44,6 @@ Makefile*
.vscode .vscode
*.bak *.bak
*~ *~
#Doxygen output does not go in repository
doxydoc

27
Doxyfile
View File

@ -1,5 +1,18 @@
# Doxyfile 1.7.4 # Doxyfile 1.7.4
#
# Required to run:
# Doxygen (http://www.doxygen.nl/)
# GraphViz (https://www.graphviz.org/)
#
# Usage:
# 1) put GraphViz bin directory in your PATH
# 2) make oscar-code the current directory
# 3) Run doxygen with no parameters. Output will be placed
# in doxygen directory. (.gitignore excludes doxygen directory from git.)
#
#
#
#
# This file describes the settings to be used by the documentation system # This file describes the settings to be used by the documentation system
# doxygen (www.doxygen.org) for a project. # doxygen (www.doxygen.org) for a project.
# #
@ -25,7 +38,7 @@ DOXYFILE_ENCODING = UTF-8
# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
# by quotes) that should identify the project. # by quotes) that should identify the project.
PROJECT_NAME = OSCR PROJECT_NAME = OSCAR
# The PROJECT_NUMBER tag can be used to enter a project or revision number. # The PROJECT_NUMBER tag can be used to enter a project or revision number.
# This could be handy for archiving the generated documentation or # This could be handy for archiving the generated documentation or
@ -37,21 +50,22 @@ PROJECT_NUMBER = 1.0.x
# for a project that appears at the top of each page and should give viewer # 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. # a quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF = OpenSource CPAP Review Software PROJECT_BRIEF = OpenSource CPAP Analysis Reporter
# With the PROJECT_LOGO tag one can specify an logo or icon that is # With the PROJECT_LOGO tag one can specify an logo or icon that is
# included in the documentation. The maximum height of the logo should not # included in the documentation. The maximum height of the logo should not
# exceed 55 pixels and the maximum width should not exceed 200 pixels. # exceed 55 pixels and the maximum width should not exceed 200 pixels.
# Doxygen will copy the logo to the output directory. # Doxygen will copy the logo to the output directory.
PROJECT_LOGO = ./docs/logo.png #PROJECT_LOGO = ./docs/logo.png
PROJECT_LOGO = ./oscar/icons/logo-lm.png
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put. # base path where the generated documentation will be put.
# If a relative path is entered, it will be relative to the location # 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. # where doxygen was started. If left blank the current directory will be used.
OUTPUT_DIRECTORY = ./docs/doxygen OUTPUT_DIRECTORY = ./doxydoc
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 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 # 4096 sub-directories (in 2 levels) under the output directory of each output
@ -610,7 +624,8 @@ WARN_LOGFILE =
# directories like "/usr/src/myproject". Separate the files or directories # directories like "/usr/src/myproject". Separate the files or directories
# with spaces. # with spaces.
INPUT = ./ ./Graphs ./SleepLib ./SleepLib/loader_plugins #INPUT = ./ ./Graphs ./SleepLib ./SleepLib/loader_plugins
INPUT = ./oscar ./oscar/Graphs ./oscar/SleepLib ./oscar/SleepLib/loader_plugins
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is