Skip to content

Need to show full argument list in docs for annotations #17982

New issue

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

Closed
DartBot opened this issue Apr 2, 2014 · 8 comments
Closed

Need to show full argument list in docs for annotations #17982

DartBot opened this issue Apr 2, 2014 · 8 comments
Assignees
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. P0 A serious issue requiring immediate resolution
Milestone

Comments

@DartBot
Copy link

DartBot commented Apr 2, 2014

This issue was originally filed by [email protected]


We have code such as this:

@ngdirective(
    children: NgAnnotation.TRANSCLUDE_CHILDREN,
    selector:'[ng-if]',
    map: const {'.': '=>condition'})
class NgIfDirective extends _NgUnlessIfAttrDirectiveBase {
...
}

Curently, only the annotation name is showing. We want the full list of arguments to be present in the output of the documentation. For example, The @­NgDirective annotation contains important information such as selector; '[ng-if]' which the user of the docs is interested in.

@efortuna
Copy link
Contributor

efortuna commented Apr 3, 2014

Set owner to @efortuna.
Added Pkg-DartDoc, Triaged labels.

@anders-sandholm
Copy link
Contributor

Added Area-Pkg label.

@kevmoo
Copy link
Member

kevmoo commented Apr 7, 2014

Removed Pkg-DartDoc label.
Added Pkg-DocGen label.

@efortuna
Copy link
Contributor

Marked this as being blocked by #18346.

@peter-ahe-google
Copy link
Contributor

I don't think this is really blocked on issue #18346. Most likely, we will have to close issue #18346, because it is asking for a feature that doesn't work in more general situations.


Unmarked this as being blocked by #18346.

@DartBot
Copy link
Author

DartBot commented Apr 22, 2014

This comment was originally written by @seaneagan


The same is desired for parameter default values, see issue #18266.

@efortuna
Copy link
Contributor

efortuna commented May 1, 2014

Added this to the 1.5 milestone.
Removed Priority-Unassigned label.
Added Priority-Critical label.

@efortuna
Copy link
Contributor

efortuna commented May 5, 2014

Added Fixed label.

@DartBot DartBot added Type-Defect P0 A serious issue requiring immediate resolution area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. labels May 5, 2014
@DartBot DartBot added this to the 1.5 milestone May 5, 2014
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. P0 A serious issue requiring immediate resolution
Projects
None yet
Development

No branches or pull requests

5 participants