Commit graph

3 commits

Author SHA1 Message Date
Stephen Niedzielski b340e04a22 Hygiene: enable syntax highlighting in JSDoc comments
Add the JSDoc Markdown plugin so that inline code snippets look their
very best. This plugin is currently used by the Popups repo and adding
it here also improves JSDoc config consistency.

Change-Id: Ib0094bed44268a1002d19ccb1a2495560331e09d
2018-07-31 09:08:35 +00:00
Stephen Niedzielski 0e28238027 Hygiene: make JSDoc configs consistent
Make the Popups, MobileFrontend, and MinervaNeue JSDocs consistent. For
MinervaNeue:

- Replace "packageX" option which was unfound in the JSDoc repo with
  "package".

- Remove redundant default configurations.

- Replace tabs with spaces since that's the standard in this repo.

http://usejsdoc.org/about-configuring-jsdoc.html
http://usejsdoc.org/about-commandline.html
http://usejsdoc.org/about-configuring-default-template.html

Bug: T188261
Change-Id: Ic767e78ceee35400bdd9bb6f51c865e475f8f337
2018-07-23 14:45:10 -05:00
jdlrobson eaa2692da0 Use jsdoc for generating Minerva documentation
Given the level of documentation in this repo is extremely
low now seems a good as time as any.

The resulting documentation is a vast improvement on before
grouping functions to an owner and introducing module names.

We can iterate on the documentation over time.

Bug: T138401
Change-Id: I9e787d40931d3d72a7037ce07d3ab0db8e72d825
2018-03-15 15:01:41 -07:00