Rockbox

This is the bug/patch tracker for Rockbox. Click here for more information.

Quick links: Bugs · Patches · Rockbox frontpage

Tasklist

FS#9462 - Automated Rockbox plugin API documentation generator

Attached to Project: Rockbox
Opened by Maurus Cuelenaere (mcuelenaere) - Monday, 06 October 2008, 17:42 GMT+2
Last edited by Maurus Cuelenaere (mcuelenaere) - Tuesday, 07 October 2008, 00:20 GMT+2
Task Type Patches
Category Plugins
Status Closed
Assigned To No-one
Player Type Another
Severity Low
Priority Normal
Reported Version Daily build (which?)
Due in Version Undecided
Due Date Undecided
Percent Complete 100%
Private No

Details

These PHP scrips generates a documentation file of apps/plugin.h which then are converted to HTML files (after manually checking/improving the documentation) for easier distribution.

This is an example of the output:

http://mcuelenaere.alwaysdata.net/rockbox_api_example/lcd.html#lcd_drawline
   rockbox_api_docu.diff (83.7 KiB) 
 utils/rockbox_api/generate.php  |   62 
 utils/rockbox_api/gen_html.php  |  110 +
 utils/rockbox_api/layout.css    |  103 +
 utils/rockbox_api/update.php    |  118 +
 utils/rockbox_api/README        |   29 
 utils/rockbox_api/functions.php |  336 +++++
 docs/plugin.DOCUMENTATION       | 2554 ++++++++++++++++++++++++++++++++++++++++
 7 files changed, 3312 insertions(+)

This task depends upon

Closed by  Maurus Cuelenaere (mcuelenaere)
Tuesday, 07 October 2008, 00:20 GMT+2
Reason for closing:  Accepted

Loading...