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
I want to create a directive which takes a parameter based on whether an attribute is present. That is:
<foo some-attr></foo>
Should do one thing, while:
<foo></foo>
Should do another thing. I know how to accomplish this in code.
The question is, how do I document this with ngdoc? Currently I have:
/** * @ngdoc directive * @name someModule.directive:foo * @restrict E * @param {boolean=} someAttr If present, will do something. */
However, when the documentation is generated with ngdocs, it looks like this:
Usage as element: <foo [some-attr="{boolean}"]> </foo>
as element:
<foo [some-attr="{boolean}"]> </foo>
This doesn't really convey what I want, which would be something like:
Usage as element: <foo [some-attr]> </foo>
<foo [some-attr]> </foo>
Is there any way to make the generated documentation look like that?
The text was updated successfully, but these errors were encountered:
Hi,
Take a look at Dgeni-alive generator, it is based on the recent dgeni-packages and provides more features than ngdocs (demo).
Sorry, something went wrong.
@csaftoiu can you just do the following?
@param [someAttr] If present, will do something.
No branches or pull requests
I want to create a directive which takes a parameter based on whether an attribute is present. That is:
Should do one thing, while:
Should do another thing. I know how to accomplish this in code.
The question is, how do I document this with ngdoc? Currently I have:
However, when the documentation is generated with ngdocs, it looks like this:
This doesn't really convey what I want, which would be something like:
Is there any way to make the generated documentation look like that?
The text was updated successfully, but these errors were encountered: