GitHub user daserge opened a pull request:
https://github.com/apache/cordova-plugin-camera/pull/129
CB-9745 Camera plugin docs should be generated from the source
Moved the docs to jsdoc comments in the code, removed redundancy.
Moved Quirks and extra examples to errata sections of the docs TEMPLATE.md,
linked the jsdoc comments to these sections.
Added dependencies to common plugin docs template and husky (precommit hook
to regen the docs automatically).
Added gen-docs command to re-generate the docs.
Extended TOC manually [to include classes containing only one
member](https://github.com/jsdoc2md/jsdoc-to-markdown/issues/34)
(CameraPopoverHandle and CameraPopoverOptions).
Extended the docs via DMD template to include "Installation", "How to
contribute" and "Docs are generated" warning.
[Jira issue](https://issues.apache.org/jira/browse/CB-9745)
[cordova-discuss PR](https://github.com/cordova/cordova-discuss/pull/16)
This version does not include source links (the patch is going through
legal approval).
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/MSOpenTech/cordova-plugin-camera CB-9745
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/cordova-plugin-camera/pull/129.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #129
----
commit 6cbd5cfab308ded5abdc5781a202a416e821a572
Author: daserge <[email protected]>
Date: 2015-10-05T10:48:19Z
CB-9745 Camera plugin docs should be generated from the source
Moved docs to jsdocs comments in the code, removed redundancy.
Moved Quirks and extra examples to errata sections of the docs TEMPLATE.md,
linked the jsdoc comments to these sections.
Added dependencies to common plugin docs template and husky (precommit hook
to regen the docs automatically).
Added gen-docs command to re-generate the docs.
Extended TOC manually [to include classes containing only one
member](https://github.com/jsdoc2md/jsdoc-to-markdown/issues/34)
(CameraPopoverHandle and CameraPopoverOptions).
Extended the docs via DMD template to include "Installation", "How to
contribute" and "Docs are generated" warning.
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
