Added support for excluding paths from the output. #133
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
This is useful if you only want to generate documentation for certain sources but those sources depend on other sources that should not have documentation generated for them. With this feature, you add all sources as input and exclude certain sources from output generation. It will hide warnings on excluded sources, not generate output for them, but they will be used for merging with your included sources (eg. inheritance etc.)
|
Might be confusing with |
tomaz
added a commit
that referenced
this pull request
Aug 26, 2011
Added support for excluding paths from the output. Use `--exclude-output` option for entering all paths that should be parsed, but excluded from generated output. Although this is similar to `--ignore`, there's one important difference: Ignore option will simply prevent any parsing happening over specified files or folders, hence it will result in warnings in case symbols from these paths are referenced in documentation that gets parsed. Exclude parses specified files or folders, but it simply doesn't output them, therefore you get no warnings. It's somewhat slower on the other hand due to having to parse extra files.
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.
This is useful if you only want to generate documentation for certain
sources but those sources depend on other sources that should not have
documentation generated for them. With this feature, you add all
sources as input and exclude certain sources from output generation. It
will hide warnings on excluded sources, not generate output for them,
but they will be used for merging with your included sources (eg.
inheritance etc.)