dgeni
dgeni copied to clipboard
Flexible JavaScript documentation generator used by AngularJS, Protractor and other JS projects
Bumps [path-parse](https://github.com/jbgutierrez/path-parse) from 1.0.6 to 1.0.7. Commits See full diff in compare view [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter...
Hi, Is there a simple example of Dgeni (similar to https://github.com/petebacondarwin/dgeni-example) that shows how you'd use it with an Angular 2 application using TypeScript? Currently I have this: ``` var...
when running 'dgeni ./dgeni-run.js' to generate docs, I have this error: ' ``` node_modules/dgeni/lib/Dgeni.js:45 throw new Error('package must be an instance of Package'); ^ Error: package must be an instance...
I'm generating JSON using dgeni but when I have a description with {@link ...} it generates a correct anchor tag but the double quotes around the href attribute value are...
I'm dying to have setting up dgeni be a better experience. Every time I go in to change anything, it seems to break things. I only had it *partially* working...
The project should be eating its own dog food by generating its own docs. This will be a good exercise in the versatility of the tool, since there are some...
Here are my thoughts on the next version of dgeni. ## Immutable data structs I think these should have the additional restriction that you can only **set** keys on an...
My grunt ngdocs task below. ``` ngdocs: { options: { dest: 'site/docs', html5Mode: false, startPage: '/api', scripts: [ 'bower_components/angular/angular.js' 'bower_components/angular-animate/angular-animate.js', 'bower_components/angular-material/angular-material.js' ] }, api: { src: ['app/**/*.js','!app/**/*-spec.js','app/index.ngdoc'], title: 'Docs' }...
hi, What could be the issue with this doc. ``` /** * @ngdoc method * @name prep.factory:prepParams#parameters * @description Set new parameters or get current parameters * * @param {string}...
Possibly using the following syntax ``` ## # @param {type} [optionalvar] Description # ``` The coffeescript documentation tools are very much lacking. Since this seems to be a flexible extensible...