Our team is in the early stages of starting a new project in Angular. As of right now we are evaluating if Typescript is right for our team, but there's one issue in our prototyping that we haven't found a solution to.
We've tried using: grunt-ngdocs <https://github.com/m7r/grunt-ngdocs> to document our API, but it doesn't seem to like Typescript as the source. We then put options on the Typescript compiler to keep comments and run it against the generated JavaScript -- but some of the comments are lost due to some Typescript constructs not really having JavaScript equivalents (like Interfaces). Not only that, we have actually seen comments that happened to use an unsupported NGDOC tag actually crash the task, instead of giving reasonable error or warning messages. (For instance, using '@ngdoc controller' will give you an example of this) Now we are looking at Docular <http://grunt-docular.com/> (which appears to just be a fork and enhancement to ngdocs) and TSDoc<https://npmjs.org/package/tsdoc>. Does anyone have any helpful advice to us in this endeavor? Thanks! -- Joe -- You received this message because you are subscribed to the Google Groups "AngularJS" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/angular. For more options, visit https://groups.google.com/groups/opt_out.
