Ignore source-code-blocks while processing comments. #555
Conversation
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
Appledoc gives warnings when it encounters parsing issues inside source code blocks. In particular, it looks for style markup and reference links. These are especially bad within ObjectiveC source code example blocks because of the ObjectiveC bracket syntax and the obligatory underscores for category methods on Cocoa classes. This is similar to bug tomaz#72, but not exactly. I noticed that in another similar report, these issues are gone in version 3, so I didn't bother trying to fix this completely. Basically, the code intercepts the markdown processing, and looks for any sections within documentation blocks that are marked with either @code/@Endcode of the ~~~/~~~ and ```/``` markdown syntax. If it finds those blocks, it will output them as markup (making sure to use the backtick format), and skip any further processing for that block of text.
tomaz
added a commit
that referenced
this pull request
Sep 8, 2015
Ignore source-code-blocks while processing comments.
|
Thanks, merged. |
jodyhagins
added a commit
to jodyhagins/appledoc
that referenced
this pull request
Sep 8, 2015
jodyhagins
added a commit
to jodyhagins/appledoc
that referenced
this pull request
Sep 8, 2015
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Appledoc gives warnings when it encounters parsing issues inside
source code blocks. In particular, it looks for style markup and
reference links. These are especially bad within ObjectiveC
source code example blocks because of the ObjectiveC bracket
syntax and the obligatory underscores for category methods on
Cocoa classes.
This is similar to bug #72, but not exactly. I noticed that in
another similar report, these issues are gone in version 3, so I
didn't bother trying to fix this completely.
Basically, the code intercepts the markdown processing, and looks
for any sections within documentation blocks that are marked with
either @code/@Endcode of the ~~~/~~~ and
/markdown syntax.If it finds those blocks, it will output them as markup (making
sure to use the backtick format), and skip any further processing
for that block of text.