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

Add doxygen configuration and target to cmake #450

Merged
merged 1 commit into from
Nov 6, 2015
Merged

Add doxygen configuration and target to cmake #450

merged 1 commit into from
Nov 6, 2015

Conversation

alberth
Copy link
Contributor

@alberth alberth commented Oct 27, 2015

As requested in #287

Dropped 'dot' to reduce dependencies, and redirected output to the build dir (which unfortunately has to be done with environment variable magic, see http://sourceforge.net/p/doxygen/mailman/doxygen-users/thread/486397E8.4030205@isis-papyrus.com/ )

The output redirection makes that you cannot easily run doxygen outside make, but I guess that's not a problem.

I also had trouble getting the warnings output onto a file, so I dropped the file, and it gets at stderr now.

@xlz
Copy link
Member

xlz commented Oct 27, 2015

Warning: Tag `XML_SCHEMA' at line 1797 of file `Doxyfile' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"
Warning: Tag `XML_DTD' at line 1803 of file `Doxyfile' has become obsolete.
         To avoid this warning please remove this line from your configuration file or upgrade it using "doxygen -u"

I'm using doxygen 1.8.9.1. As is suggested by the warnings, I think it can be removed.

Also, we don't want documentation for internal headers

-EXCLUDE_PATTERNS       =
+EXCLUDE_PATTERNS       = */include/internal/*

With these two changes, the generated html looks good as a basis for more docs.

Also, you might want to note in commit message that the docs are not automatically generated, it needs make doc.

After generating the Makefile, documentation is generated by issueing "make
doc", and ends up in the "doc" sub-directory in the build directory.
@alberth
Copy link
Contributor Author

alberth commented Oct 28, 2015

Updated with all suggestions

@floe floe added this to the 0.1 milestone Oct 28, 2015
floe added a commit that referenced this pull request Nov 6, 2015
Add doxygen configuration and target to cmake
@floe floe merged commit 474b2fc into OpenKinect:master Nov 6, 2015
@floe
Copy link
Contributor

floe commented Nov 6, 2015

@alberth thanks for your work, merged.

Github pages should be good for hosting the docs, does anybody know if it can auto-run doxygen somehow?

@floe floe mentioned this pull request Nov 6, 2015
@HenningJ
Copy link
Contributor

HenningJ commented Nov 6, 2015

Github pages should be good for hosting the docs, does anybody know if it can auto-run doxygen somehow?

Take a look here: http://blog.gockelhut.com/2014/09/automatic-documentation-publishing-with.html

@alberth alberth deleted the cmake_doxygen_config branch November 9, 2015 07:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants