rockbox

mirror of https://github.com/Rockbox/rockbox.git synced 2025-10-13 10:07:38 -04:00

History

Solomon Peachy c65050571e docs: Do a proper "merge" with the API docs This keeps all the old descriptions etc that were there before. Had to fix up the tools some more, honestly feels better to just rewrite this crap in perl. Change-Id: Ic15deae200c143ba5457423e12c81f871c0fef09		2025-04-21 15:59:00 -04:00
..
functions.php	docs: Do a proper "merge" with the API docs	2025-04-21 15:59:00 -04:00
gen_html.php	api: Fix some basic syntax problems with the plugin API generator	2025-04-20 17:07:40 -04:00
generate.php	docs: Do a proper "merge" with the API docs	2025-04-21 15:59:00 -04: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
README	Commit FS#9462: an semi-automatic plugin API documentation generator	2008-10-06 22:19:54 +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	docs: Do a proper "merge" with the API docs	2025-04-21 15:59:00 -04: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