Questions tagged [grunt-ngdocs]
13 questions
7
votes
3 answers
ngdoc documentation for controller
I am to new to code documentation and trying to document my angular application with grunt-ngdocs.
I cloned a working example from: https://github.com/m7r/grunt-ngdocs-example
The given example lacks a documented controller so I added my own…
noviewpoint
- 574
- 1
- 10
- 20
4
votes
1 answer
AngularJs ngdocs: annotate that a method returns a promise
Im am currently in the process of documenting my first real AngularJs app, for wich a am using ngdocs syntax with grunt-ngdocs
I was wondering if there is a better way to annotate that my service method returns a promise (so you know you should…
Maarten Van De Velde
- 43
- 4
3
votes
1 answer
ngdocs - how to document a module config and run block
I have recently started using ngdocs in my angular application, and I am stumped on how to sensibly document a modules config and run block.
I have this currently:
/**
* @ngdoc overview
* @name app.core
* @description
* # app.core
* This module…
mindparse
- 6,115
- 27
- 90
- 191
2
votes
1 answer
Usage of ngdocs with controller properties in angularJS
I am just starting to get to grip using grunt-ngdocs for my angular application and so far so good.
But I would now like to document some properties of another documented prperty in one of my controllers.
Consider the following code:
(function() {
…
mindparse
- 6,115
- 27
- 90
- 191
2
votes
1 answer
angularjs create documentation via grunt and ngdocs
Hello I'm trying to create a documentation for my ionicframework/angularjs application via grunt and ngdoc.
I've installed everything like preferred in http://gruntjs.com/getting-started
Well if I now run grunt
I get:
Running "jshint:gruntfile"…
Kingalione
- 4,237
- 6
- 49
- 84
2
votes
1 answer
grunt-ngdoc is not rendering examples for my ngdoc documentation
I'm trying to get a basic example to work using ngDoc for my Angular project.
Here is an example:
/**
* @ngdoc directive
* @name ui.components.uiRepeat
* @description
*
* Place this attribute directive on any element that has an `ng-repeat` on…
Reactgular
- 52,335
- 19
- 158
- 208
2
votes
1 answer
grunt-ngdocs: styles file not included to demo code
I am using grunt-ngdocs to document my Angular project. But the demo Plunker code (generated automatically) doesn't include the CSS file.
My configuration in Gruntfile.js includes:
...
scripts: [
…
Joy
- 9,430
- 11
- 44
- 95
1
vote
0 answers
How to get Offline Document version of ngdocs Web Application?
I am using ngdocs for documention of my Angular JS Project.
Link : https://www.npmjs.com/package/gulp-ngdocs
Running gulp ngdocs generates the docs folder , which is an Angular Application to show the JS DOcs.
How can i convert this Web App into a…
Sabyasachi
- 411
- 4
- 9
- 21
1
vote
0 answers
ngdoc example block not working if i add angular material as dependency
My grunt ngdocs task below.
`
ngdocs: {
options: {
dest: 'site/docs',
html5Mode: false,
startPage: '/api',
scripts: [
…
balachander j
- 53
- 1
- 1
- 6
1
vote
1 answer
ngdocs - how to add styles to live demo example
I'd like to add my css stylesheets to the live demo examples in the ngdocs documentation.
I want the styles to affect the demo itself, but obviously, they should not affect the entire web page.
I tried adding my stylesheet to the gruntfile ngdocs…
code2b
- 132
- 2
- 3
- 11
0
votes
1 answer
ngdocs:Cannot read property 'replace' of undefined
Whenever we run gulp/grunt task using ngdocs npm module docs folder is generated, if we click on index.html in console it throws the following error
TypeError: Cannot read property 'replace' of undefined
at Gb (angular.js:10638)
at Me.$get…
SU15
- 873
- 2
- 11
- 15
0
votes
1 answer
Unable to view descriptions of generated docs
although I'm able to serve from filesystem the grunt-ngdocs automatically generated index.html, everytime I try to look to a description in the documentation I'm getting:
XMLHttpRequest cannot load file:///C:/ Cross origin requests are…
Gargaroz
- 313
- 9
- 28
0
votes
0 answers
creating ngdocs example with a custom directive
Hello I'm trying to create a example for a directive with grunt-ngdocs: https://github.com/m7r/grunt-ngdocs
The documentation for the example tag is very poor so I could not create a working example not in ng-docs and also not in plnkr.
My example…
Kingalione
- 4,237
- 6
- 49
- 84