Merged
Conversation
Current coverage is 100% (diff: 100%)@@ master #32 diff @@
===================================
Files 1 2 +1
Lines 2 11 +9
Methods 0 0
Messages 0 0
Branches 0 0
===================================
+ Hits 2 11 +9
Misses 0 0
Partials 0 0
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added a Doxygen build to this project,
Doxygen parses the
srcdirectories to build API documentation. It uses the file extension to identify the required parser (.cppfor C++,.javafor Java, etc.), parses the code, and renders markup in the comments into HTML documentation.Custom content can be included in Markdown or HTML.
This PR aims to fix issue #5.
I tried to automate the build process, but I found it requiring of a bit more attention than I initially expected. If this PR gets approved, I'm going to open an issue to automate the documentation build.
This gist offers some insight into how to do it. The author's solution was to write a shell script, but I believe the required scripting can be done in Gradle as well.