summaryrefslogtreecommitdiffstats
path: root/utils/rockbox_api/README
diff options
context:
space:
mode:
authorMaurus Cuelenaere <mcuelenaere@gmail.com>2008-10-06 22:19:54 +0000
committerMaurus Cuelenaere <mcuelenaere@gmail.com>2008-10-06 22:19:54 +0000
commit20fb47ec778abe215ca69692434ff753596319e6 (patch)
tree69665298c0f58c07a1aa9677d33ad395ad9ccd13 /utils/rockbox_api/README
parent34148b9a2173b0bd80b4acd18d23216ae54cb865 (diff)
downloadrockbox-20fb47ec778abe215ca69692434ff753596319e6.tar.gz
rockbox-20fb47ec778abe215ca69692434ff753596319e6.tar.bz2
rockbox-20fb47ec778abe215ca69692434ff753596319e6.zip
Commit FS#9462: an semi-automatic plugin API documentation generator
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18722 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'utils/rockbox_api/README')
-rw-r--r--utils/rockbox_api/README29
1 files changed, 29 insertions, 0 deletions
diff --git a/utils/rockbox_api/README b/utils/rockbox_api/README
new file mode 100644
index 0000000000..1ed251c918
--- /dev/null
+++ b/utils/rockbox_api/README
@@ -0,0 +1,29 @@
+==============================
+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 \ No newline at end of file