We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
It isn't stated clearly in readme what kind of tags are supported. So I'd exprect that DOX support any ones. But it not the case. For example:
{ "tags": [], "description": { "full": "<p>@module core</p>", "summary": "<p>@module core</p>", "body": "" }, "isPrivate": false, "ignore": false, "code": "define([\n\t\"jquery\", \"lib/core.lang\", \"lib/binding\",\n\t\"lib/core.events\", \"lib/core.composition\", \"lib/core.diagnostics\", \"lib/core.commands\", \"lib/core.html\",\n\t\"lib/utils\", \"lib/ui/Part\", \"lib/ui/StatefulPart\", \"lib/ui/Component\", \"lib/ui/handlebars/View\",\n\t\"vendor/cookies\", \"i18n!lib/nls/resources\",\n\t\"vendor/history\", \"vendor/modernizr\", \"lib/core.jquery\"\n], function (\n\t$, lang, binding,\n\tevents, composition, diagnostics, commands, html,\n\tutils, Part, StatefulPart, Component, View,\n\tCookies, resources\n) {\n\t\"use strict\";" },
Here tag "@module" was not understand.
So what tags are supported? And why not anyone?
The text was updated successfully, but these errors were encountered:
The tags currently supported by dox are as follows:
Reference: https://github.com/visionmedia/dox/blob/master/lib/dox.js#L191
The reason for a specific set of tags is due to the fact that the values for each of these tags are modified in different ways (see the link above).
Sorry, something went wrong.
I think that we need to implement a bit more intelligent behaviour for default case than tag.string = parts.join(' ');. Will think about it.
tag.string = parts.join(' ');
I agree with @envindor.
There're 3 types of tag:
@api public
@private
@example some code snippet...
In current implementation which depends on split('\n') and join(' '), the third case makes problematic.
split('\n')
join(' ')
I tried to fix it, but it's too dirty and buggy without rewriting parseTag.
No branches or pull requests
It isn't stated clearly in readme what kind of tags are supported. So I'd exprect that DOX support any ones.
But it not the case.
For example:
Here tag "@module" was not understand.
So what tags are supported? And why not anyone?
The text was updated successfully, but these errors were encountered: