05. Code Documentation - medullan/mean GitHub Wiki

Code Documentation

Code documentation was split for the server-side and front-end code.

  • ng-docs for the front-end
  • doxx for the server-side code

To generate documentation for both sets of code, run:

$ grunt docs

Output:

  • UI Docs Location: .reports/docs/ngdocs
  • Server Docs Location: .reports/docs/doxx

Things to node

  • Please ensure you angular code comments follow the ng-doc standards
  • Please ensure you nodejs code comments follow jsodc3 standards