rockbox/utils/rockbox_api
Solomon Peachy 2434b6ca25 misc: Remove all 'twiki' references in favor of up-to-date 'wiki' links.
(This migration happened over a decade ago!)

Change-Id: Ib396414a16f2d763e549af49e3f3b03047dab49c
2020-06-07 01:38:55 +00:00
..
README Commit FS#9462: an semi-automatic plugin API documentation generator 2008-10-06 22:19:54 +00:00
functions.php Improve plugin API documentation updater a bit 2008-10-09 11:48:26 +00:00
gen_html.php Functionize some stuff 2008-10-09 09:57:21 +00:00
generate.php Commit FS#9462: an semi-automatic plugin API documentation generator 2008-10-06 22:19:54 +00:00
index.tpl misc: Remove all 'twiki' references in favor of up-to-date 'wiki' links. 2020-06-07 01:38:55 +00:00
layout.css Add Rockbox layout to plugin API documentation 2008-10-09 12:24:57 +00:00
menu.tpl Fix some issues with generation of plugin API documentation + make it more themeable 2008-10-09 09:49:53 +00:00
section.tpl misc: Remove all 'twiki' references in favor of up-to-date 'wiki' links. 2020-06-07 01:38:55 +00:00
update.php Improve plugin API documentation updater a bit 2008-10-09 11:48:26 +00:00

README

==============================
generate.php
==============================

 php generate.php > output.txt

--------------
 Generates output.txt of apps/plugin.h

==============================
update.php
==============================

 php update.php input_file.txt > output.txt

--------------
 Updates input_file.txt with newer values of apps/plugin.h

==============================
gen_html.php
==============================

 php gen_html.php input_file.txt

--------------
 Generates HTML output of input_file.txt in output/*.html
 
 Known issues:
  * [F[function]] doesn't work with functions outside of the current .html