[nesting] path construction in comment parser #73
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
1. Implemented simple path construction (adjustPath) in parseComments. 2. Added test. 3. Added a fixture for said test.
|
hmm im slightly confused by this, why nest them all weird? |
|
I'm just trying to automate our documentation system a little bit. Knowing what's parented by what else, I can structure documentation output (html or something) in such a way that member functions can be nested inside classes, etc. Is there another way to accomplish this? I did write this in the morning... |
|
I just haven't seen them nested like that, maybe it's best in a fork of dox |
|
Which part is confusing though? Nesting like https://github.com/visionmedia/dox/pull/73/files#L2R27 ? |
Closed
|
Outdated, sorry. |
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.
Without disrupting the way dox already constructs its output, this patch offers a way for people to use the output to build nested structure. For example, having a class with members: paths offer some insight into how your documentation can be structured.