You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Apr 12, 2024. It is now read-only.
Do you want to request a feature or report a bug?
bug
What is the current behavior?
None of the @example comment blocks of the methods of the $provide service are included in the generated API documentation.
If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://plnkr.co or similar (template: http://plnkr.co/edit/tpl:yBpEi4).
Locally reproduced the bug by cloning the "angular.js" GitHub repo and after a grunt package I had the same issue in my locally generated docs in ./build/docs
What is the expected behavior?
All of the methods of $provide have a @example comment and therefor each method should have a comment in the generated API docs.
To illustrate things I've included the jsdoc comment of $provide#value below:
What is the motivation / use case for changing the behavior?
It's a waste to not include those nice code examples in the generated API docs
Which versions of Angular, and which browser / OS are affected by this issue? Did this work in previous versions of Angular? Please also test with the latest stable and snapshot (https://code.angularjs.org/snapshot/) versions.
Checked both sources and API docs of latest 1.5, 1.4, 1.3 and 1.2 versions of AngularJS and all source-code had the @example comments but for none of them it was included in the generated API docs.
Other information (e.g. stacktraces, related issues, suggestions how to fix)
The text was updated successfully, but these errors were encountered:
Currently, ngdoc @method ignores @example tags. Examples are usually
rendered directly into the @description via code blocks or <example>
elements. However, some methods still have @example tags (possibly
from a previous docs version), which are currently not visible.
While not absolutely necessary, having special markup for Examples
makes them a) easier to find visually in the docs, and b) easier
to link to as they will have a unique id.
Closesangular#14722
Narretz
added a commit
to Narretz/angular.js
that referenced
this issue
Nov 29, 2016
Currently, ngdoc `@method` ignores `@example` tags and does not output them.
This is usually not a problem, as examples are mostly defined directly
in the `@description` via code blocks or `<example>`
elements. However, some methods still have `@example` tags (possibly
from a previous docs version).
While not absolutely necessary, having special markup for Examples
makes them a) easier to find visually in the docs, and b) easier
to link to as they will have a unique id.
Closesangular#14722
Currently, ngdoc `@method` ignores `@example` tags and does not output them.
This is usually not a problem, as examples are mostly defined directly
in the `@description` via code blocks or `<example>`
elements. However, some methods still have `@example` tags (possibly
from a previous docs version).
While not absolutely necessary, having special markup for Examples
makes them a) easier to find visually in the docs, and b) easier
to link to as they will have a unique id.
Closes#14722Closes#15448
ellimist
pushed a commit
to ellimist/angular.js
that referenced
this issue
Mar 15, 2017
Currently, ngdoc `@method` ignores `@example` tags and does not output them.
This is usually not a problem, as examples are mostly defined directly
in the `@description` via code blocks or `<example>`
elements. However, some methods still have `@example` tags (possibly
from a previous docs version).
While not absolutely necessary, having special markup for Examples
makes them a) easier to find visually in the docs, and b) easier
to link to as they will have a unique id.
Closesangular#14722Closesangular#15448
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Do you want to request a feature or report a bug?
bug
What is the current behavior?
None of the
@example
comment blocks of the methods of the$provide
service are included in the generated API documentation.If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://plnkr.co or similar (template: http://plnkr.co/edit/tpl:yBpEi4).
Locally reproduced the bug by cloning the "angular.js" GitHub repo and after a
grunt package
I had the same issue in my locally generated docs in ./build/docsWhat is the expected behavior?
All of the methods of
$provide
have a@example
comment and therefor each method should have a comment in the generated API docs.To illustrate things I've included the jsdoc comment of $provide#value below:
Unfortunately the nice example included in the jsdoc of
.value
is not included in the generated API docs of the method: https://docs.angularjs.org/api/auto/service/$provide#valueWhat is the motivation / use case for changing the behavior?
It's a waste to not include those nice code examples in the generated API docs
Which versions of Angular, and which browser / OS are affected by this issue? Did this work in previous versions of Angular? Please also test with the latest stable and snapshot (https://code.angularjs.org/snapshot/) versions.
Checked both sources and API docs of latest 1.5, 1.4, 1.3 and 1.2 versions of AngularJS and all source-code had the
@example
comments but for none of them it was included in the generated API docs.Other information (e.g. stacktraces, related issues, suggestions how to fix)
The text was updated successfully, but these errors were encountered: