github/cordova-plugin-camera
3
0
Fork 0
mirror of https://github.com/apache/cordova-plugin-camera.git synced 2026-05-18 00:00:08 +08:00
Code Issues Packages Projects Releases Wiki Activity

Remove automatic README generation (#365)

Browse Source
This commit is contained in:
jcesarmobile
2018-11-01 16:13:52 +01:00
committed by GitHub
parent c0d78ad644
commit 07e85742aa
3 changed files with 1 additions and 475 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
-9
View File
@@ -63,15 +63,6 @@ In order for your changes to be accepted, you need to sign and submit an Apache
**And don't forget to test and document your code.**
## This documentation is generated by a tool
⚠ Run `npm install` in the plugin repo to enable automatic docs generation if you plan to send a PR.
[jsdoc-to-markdown](https://www.npmjs.com/package/jsdoc-to-markdown) is used to generate the docs.
Documentation consists of template and API docs produced from the plugin JS code and should be regenerated before each commit (done automatically via [husky](https://github.com/typicode/husky), running `npm run gen-docs` script as a `precommit` hook - see `package.json` for details).
### iOS Quirks
Since iOS 10 it's mandatory to provide an usage description in the `info.plist` if trying to access privacy-sensitive data. When the system prompts the user to allow access, this usage description string will displayed as part of the permission dialog box, but if you didn't provide the usage description, the app will crash before showing the dialog. Also, Apple will reject apps that access private data but don't provide an usage description.