Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOXYGEN: Add doxygen build files #2457

Open
wants to merge 1 commit into
base: master
from

Conversation

@b-gent
Copy link

b-gent commented Sep 11, 2020

This commit adds the doxygen build framework to the main
scummvm repo.
This allows to easily build and test API doc when making any
kind of changes in doxygen blocks in header files.

The build can be run from command line in the 'doxygen'
folder with 'doxygen scummvm.doxyfile'.

Output is produced in the 'html' folder and can be viewed
by opening the 'index.html' file.

The 'buildfiles' folder contains files related to style.

This commit adds the doxygen build framework to the main
scummvm repo.
This allows to easily build and test API doc when making any
kind of changes in doxygen blocks in header files.

The build can be run from command line in the 'doxygen'
folder with 'doxygen scummvm.doxyfile'.

Output is produced in the 'html' folder and can be viewed
by opening the 'index.html' file.

The 'buildfiles' folder contains files related to style.
@deepcode-ci-bot
Copy link

deepcode-ci-bot bot commented Sep 11, 2020

Congratulations 🎉. DeepCode analyzed your code in 2.124 seconds and we found no issues. Enjoy a moment of no bugs ☀️.

👉 View analysis in DeepCode’s Dashboard | Configure the bot

@b-gent
Copy link
Author

b-gent commented Sep 11, 2020

Retry DeepCode

@Mataniko Mataniko requested review from Mataniko and sev- Sep 12, 2020
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 Pieter Conradie <https://piconomix.com>

This comment has been minimized.

@Mataniko

Mataniko Sep 13, 2020 Contributor

What is this license file for?

# performance problems for the file system.
# The default value is: NO.

CREATE_SUBDIRS = NO

This comment has been minimized.

@Mataniko

Mataniko Sep 13, 2020 Contributor

may be needed TRUE with our amount of files

# entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used.

OUTPUT_DIRECTORY = html/

This comment has been minimized.

@Mataniko

Mataniko Sep 13, 2020 Contributor

/var/www/doxygen

doc/doxygen/groups.dox Show resolved Hide resolved
doc/doxygen/links.doxyfile Show resolved Hide resolved
@@ -0,0 +1,2484 @@
# Doxyfile 1.8.14

This comment has been minimized.

@Mataniko

Mataniko Sep 13, 2020 Contributor

Why are there two doxyfiles?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

2 participants
You can’t perform that action at this time.