You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cordova.apache.org by "Sergey Shakhnazarov (Akvelon)" <v-...@microsoft.com> on 2015/09/04 22:56:23 UTC
Plugin docs generation
Hi guys,
Please review a proposal on plugin documentation generation:
https://github.com/cordova/cordova-discuss/issues/15
Best regards,
Sergey Shakhnazarov
Re: Plugin docs generation
Posted by Carlos Santana <cs...@gmail.com>.
This is great!, left feedback on the PR
On Wed, Sep 23, 2015 at 8:11 PM Steven Gill <st...@gmail.com> wrote:
> I left some feedback on the PR
>
> On Mon, Sep 21, 2015 at 3:28 AM, Sergey Shakhnazarov (Akvelon) <
> v-seshak@microsoft.com> wrote:
>
> > Hello dev-list,
> >
> > I have squashed plugin docs-gen issue into the PR[1], please take a look,
> > I would appreciate your feedback!
> > The solution uses jsdoc-to-markdown to generate md from JSDoc code
> > comments with some customizations to enable source code links and ability
> > to move large chunks (f.e. Quirks) to the template.
> >
> > Please let me know if you have any questions or considerations.
> >
> > [1]: https://github.com/cordova/cordova-discuss/pull/16
> >
> > Best regards,
> > Sergey Shakhnazarov
> >
> > -----Original Message-----
> > From: Sergey Shakhnazarov (Akvelon) [mailto:v-seshak@microsoft.com]
> > Sent: Friday, September 4, 2015 11:56 PM
> > To: dev@cordova.apache.org
> > Subject: Plugin docs generation
> >
> > Hi guys,
> >
> > Please review a proposal on plugin documentation generation:
> >
> >
> https://na01.safelinks.protection.outlook.com/?url=https%3a%2f%2fgithub.com%2fcordova%2fcordova-discuss%2fissues%2f15&data=01%7c01%7cv-seshak%40microsoft.com%7cecfd69748ea64d0641fd08d2b56b510e%7c72f988bf86f141af91ab2d7cd011db47%7c1&sdata=8M0Ab3UIpNxGCFEqEza3%2bEkQgb6Xr235sjeagi1FtWA%3d
> >
> > Best regards,
> > Sergey Shakhnazarov
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
> > For additional commands, e-mail: dev-help@cordova.apache.org
> >
> >
>
Re: Plugin docs generation
Posted by Steven Gill <st...@gmail.com>.
I left some feedback on the PR
On Mon, Sep 21, 2015 at 3:28 AM, Sergey Shakhnazarov (Akvelon) <
v-seshak@microsoft.com> wrote:
> Hello dev-list,
>
> I have squashed plugin docs-gen issue into the PR[1], please take a look,
> I would appreciate your feedback!
> The solution uses jsdoc-to-markdown to generate md from JSDoc code
> comments with some customizations to enable source code links and ability
> to move large chunks (f.e. Quirks) to the template.
>
> Please let me know if you have any questions or considerations.
>
> [1]: https://github.com/cordova/cordova-discuss/pull/16
>
> Best regards,
> Sergey Shakhnazarov
>
> -----Original Message-----
> From: Sergey Shakhnazarov (Akvelon) [mailto:v-seshak@microsoft.com]
> Sent: Friday, September 4, 2015 11:56 PM
> To: dev@cordova.apache.org
> Subject: Plugin docs generation
>
> Hi guys,
>
> Please review a proposal on plugin documentation generation:
>
> https://na01.safelinks.protection.outlook.com/?url=https%3a%2f%2fgithub.com%2fcordova%2fcordova-discuss%2fissues%2f15&data=01%7c01%7cv-seshak%40microsoft.com%7cecfd69748ea64d0641fd08d2b56b510e%7c72f988bf86f141af91ab2d7cd011db47%7c1&sdata=8M0Ab3UIpNxGCFEqEza3%2bEkQgb6Xr235sjeagi1FtWA%3d
>
> Best regards,
> Sergey Shakhnazarov
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
> For additional commands, e-mail: dev-help@cordova.apache.org
>
>
RE: Plugin docs generation
Posted by "Sergey Shakhnazarov (Akvelon)" <v-...@microsoft.com>.
Hello dev-list,
I have squashed plugin docs-gen issue into the PR[1], please take a look, I would appreciate your feedback!
The solution uses jsdoc-to-markdown to generate md from JSDoc code comments with some customizations to enable source code links and ability to move large chunks (f.e. Quirks) to the template.
Please let me know if you have any questions or considerations.
[1]: https://github.com/cordova/cordova-discuss/pull/16
Best regards,
Sergey Shakhnazarov
-----Original Message-----
From: Sergey Shakhnazarov (Akvelon) [mailto:v-seshak@microsoft.com]
Sent: Friday, September 4, 2015 11:56 PM
To: dev@cordova.apache.org
Subject: Plugin docs generation
Hi guys,
Please review a proposal on plugin documentation generation:
https://na01.safelinks.protection.outlook.com/?url=https%3a%2f%2fgithub.com%2fcordova%2fcordova-discuss%2fissues%2f15&data=01%7c01%7cv-seshak%40microsoft.com%7cecfd69748ea64d0641fd08d2b56b510e%7c72f988bf86f141af91ab2d7cd011db47%7c1&sdata=8M0Ab3UIpNxGCFEqEza3%2bEkQgb6Xr235sjeagi1FtWA%3d
Best regards,
Sergey Shakhnazarov
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@cordova.apache.org
For additional commands, e-mail: dev-help@cordova.apache.org