From 20fb47ec778abe215ca69692434ff753596319e6 Mon Sep 17 00:00:00 2001 From: Maurus Cuelenaere Date: Mon, 6 Oct 2008 22:19:54 +0000 Subject: 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 --- utils/rockbox_api/gen_html.php | 110 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 110 insertions(+) create mode 100755 utils/rockbox_api/gen_html.php (limited to 'utils/rockbox_api/gen_html.php') diff --git a/utils/rockbox_api/gen_html.php b/utils/rockbox_api/gen_html.php new file mode 100755 index 0000000..34e124f --- /dev/null +++ b/utils/rockbox_api/gen_html.php @@ -0,0 +1,110 @@ +#!/usr/bin/php +Plugin API - INDEX'); + +fwrite($h, "

Plugin API reference

"); +fwrite($h, ""); + +fclose($h); + +$menu = '"; + +foreach($inh as $group_name => $group) +{ + $h = fopen("output/".get_group($group_name).".html", "w"); + + fwrite($h, 'Plugin API - '.ucwords($group_name).''); + fwrite($h, ''); + fwrite($h, '
'); + fwrite($h, ''); + + fwrite($h, "

".ucwords($group_name)."

"); + fwrite($h, ''); + foreach($group as $func_name => $func) + { + fwrite($h, ''); + + fwrite($h, "

$func_name

"); + + if(strlen($func["description"][0]) > 0) + fwrite($h, do_markup($func["description"][0])."

"); + + if(isset($func["param"])) + { + $params = ""; + foreach($func["param"] as $param) + { + $param = trim($param); + $p1 = substr($param, 0, strpos($param, " ")); + $p2 = substr($param, strpos($param, " ")); + if(strlen($p1) > 0 && strlen($p2) > 0) + $params .= '
'.$p1.'
'.do_markup($p2).'
'; + } + + if(strlen($params) > 0) + { + fwrite($h, 'Parameters:
'); + fwrite($h, $params); + fwrite($h, "
"); + } + } + + if(isset($func["return"]) && strlen($func["return"][0]) > 0) + fwrite($h, 'Returns: '.do_markup($func["return"][0]).'

'); + + if(isset($func["conditions"])) + fwrite($h, 'Conditions: '.$func["conditions"][0].'

'); + + if(isset($func["see"])) + fwrite($h, 'Also see '.do_see_markup(explode(" ", trim($func["see"][0]))).'

'); + + fwrite($h, 'To top
'); + } + fwrite($h, ""); + + fwrite($h, "
"); + + fclose($h); +} + +copy("layout.css", "output/layout.css"); +?> \ No newline at end of file -- cgit v1.1