cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Josh Soref <jso...@blackberry.com>
Subject RE: Plugin-doc standards
Date Mon, 13 Apr 2015 22:10:30 GMT
+1

> -----Original Message-----
> From: Murat Sutunc [mailto:muratsu@microsoft.com]
> Sent: Friday, April 10, 2015 4:57 PM
> To: dev@cordova.apache.org
> Subject: Plugin-doc standards
> 
> Hey folks,
> I've forgot to mention this on the hangout today but I was thinking maybe
we
> can have some guidelines on how we write plugin docs. Below is a modified
> version of doc that I've made (mostly borrowed from globalization plugin).
> 
> https://github.com/muratsu/cordova-doc
> 
> Should we apply this style to all of the docs? What are your thoughts?
> 
> Sample:
> 
> # plugin-name
> 
> Some description
> 
> ## Installation
> 
> Steps
> 
> ## API
> - API
>     - Methods
>     - Class: And others
> 
> ## plugin-name.firstMethod
> 
> Method params and short description
> 
> #### Description
> 
> Detailed explanation
> 
> #### Supported Platforms
> 
> Pass/Fail for platforms
> 
> #### Example
> 
> Small example how to use
> 
> #### Plat1 Quirks
> 
> Quirk list
> 
> #### Plat2 Quirks
> 
> ...
> 
> Thanks,
> Murat


Mime
View raw message