You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@cordova.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2015/10/05 13:08:26 UTC
[jira] [Commented] (CB-9745) Camera plugin docs should be generated
from the source
[ https://issues.apache.org/jira/browse/CB-9745?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14943233#comment-14943233 ]
ASF GitHub Bot commented on CB-9745:
------------------------------------
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 <v-...@microsoft.com>
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.
----
> Camera plugin docs should be generated from the source
> ------------------------------------------------------
>
> Key: CB-9745
> URL: https://issues.apache.org/jira/browse/CB-9745
> Project: Apache Cordova
> Issue Type: Sub-task
> Components: Plugin Camera
> Reporter: Sergey Shakhnazarov
> Assignee: Sergey Shakhnazarov
>
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@cordova.apache.org
For additional commands, e-mail: issues-help@cordova.apache.org