This repository has been archived by the owner on Mar 7, 2019. It is now read-only.
Add --todo option to handle @todo tags #55
Conversation
This file contains 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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add the new todo option in javasphinx-apidoc, enabled with
-dor--todo.If enabled, each time a
@todotag appears on a Javadoc comment, a reST todo directive is added to the generated doc. As a result, the list of all todo tasks in the Java code can be generated with the.. todolist::directive.Of course, it works only if sphinx.ext.todo is added to the list of extensions.
This option and its working principle is inspired by the useful todo option from Doxygen.
Note : I also added in this PR a test folder, in commit ece212a. I used it to test this functionality and I think it makes sense to keep it in the repository in order to developers.