[nesting] path construction in comment parser #73

Closed
wants to merge 1 commit into
from

Conversation

Projects
None yet
3 participants
@secretrobotron
  1. Implemented simple path construction (adjustPath) in parseComments.
  2. Added test.
  3. Added a fixture for said test.

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.

[nesting] path construction in comment parser
1. Implemented simple path construction (adjustPath) in parseComments.
2. Added test.
3. Added a fixture for said test.
@tj

This comment has been minimized.

Show comment Hide comment
@tj

tj Nov 22, 2012

Owner

hmm im slightly confused by this, why nest them all weird?

Owner

tj commented Nov 22, 2012

hmm im slightly confused by this, why nest them all weird?

@secretrobotron

This comment has been minimized.

Show comment Hide comment
@secretrobotron

secretrobotron Nov 22, 2012

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'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...

@tj

This comment has been minimized.

Show comment Hide comment
@tj

tj Nov 22, 2012

Owner

I just haven't seen them nested like that, maybe it's best in a fork of dox

Owner

tj commented Nov 22, 2012

I just haven't seen them nested like that, maybe it's best in a fork of dox

@secretrobotron

This comment has been minimized.

Show comment Hide comment
@secretrobotron

secretrobotron Nov 22, 2012

Which part is confusing though? Nesting like https://github.com/visionmedia/dox/pull/73/files#L2R27 ?

Which part is confusing though? Nesting like https://github.com/visionmedia/dox/pull/73/files#L2R27 ?

@ouhouhsami ouhouhsami referenced this pull request Sep 4, 2014

Closed

nested ouput #129

@evindor

This comment has been minimized.

Show comment Hide comment
@evindor

evindor Sep 7, 2014

Collaborator

Outdated, sorry.

Collaborator

evindor commented Sep 7, 2014

Outdated, sorry.

@evindor evindor closed this Sep 7, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment