@module takes an arg, to give name (re #5)#8
Open
gregglind wants to merge 1 commit intoolivernn:masterfrom
Open
@module takes an arg, to give name (re #5)#8gregglind wants to merge 1 commit intoolivernn:masterfrom
gregglind wants to merge 1 commit intoolivernn:masterfrom
Conversation
@module and @memberof together are enough to force a tree-like structure to the document. However @module requires a `ctx` object to get a sensible name (from ctx.name). For the `main` module (and in some other cases, like weird coding patters, evals, and anywhere else the regex pased detection in `dox` fails (Moz code like 'const','let', others), that name will be non-existent or wrong. Here: @module modname will specify a module name to use.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
@module and @memberof together are enough to force a tree-like structure
to the document. However @module requires a
ctxobject to get asensible name (from ctx.name). For the
mainmodule (and in some othercases, like weird coding patters, evals, and anywhere else the regex
pased detection in
doxfails (Moz code like 'const','let', others),that name will be non-existent or wrong.
Here:
@module modname
will specify a module name to use.