search

backdrop-contrib / api

Generates HTML-formatted pages of documentation from PHPdoc.
0 stars 1 forks source link

Parse and include JavaScript documentation #1

Open quicksketch opened 9 years ago

quicksketch commented 9 years ago

Searching https://api.backdropcms.org/ for 'backdropSetSummary' (a Javascript function implemented in misc/form.js) yielded no results.
We should add the core Javascript functions to the API documentation.

Spinoff from https://github.com/backdrop/backdrop-issues/issues/809.

Drupal.org issue: https://www.drupal.org/node/25901

serundeputy commented 9 years ago

looks like d.o is setting up a different site for js docs. https://www.drupal.org/node/2501135

should we do the same?

quicksketch commented 9 years ago

I'd like to see how that pans out for d.o. I would think using a NodeJS parser and what sounds like static HTML files could be problematic from a maintenance and integration stand-point. Let's let them run ahead and see how it goes before spending resources on it (unless someone is strongly motivated to try it for Backdrop first).

On Sun, Aug 2, 2015 at 6:20 AM Geoff St. Pierre notifications@github.com wrote:

looks like d.o is setting up a different site for js docs. https://www.drupal.org/node/2501135

should we do the same?

— Reply to this email directly or view it on GitHub https://github.com/backdrop-contrib/api/issues/1#issuecomment-127023867.