summaryrefslogtreecommitdiffstats
path: root/utils/rockbox_api/section.tpl
diff options
context:
space:
mode:
authorMaurus Cuelenaere <mcuelenaere@gmail.com>2008-10-09 09:49:53 +0000
committerMaurus Cuelenaere <mcuelenaere@gmail.com>2008-10-09 09:49:53 +0000
commit8c0b661d074a7f9a9c42f143304c4807084f3cea (patch)
tree40ccdbadd4949eec7842f9e85e489b3a079136ba /utils/rockbox_api/section.tpl
parenta1c80948c270881cbcf41f6012f67c0751c2245f (diff)
downloadrockbox-8c0b661d074a7f9a9c42f143304c4807084f3cea.tar.gz
rockbox-8c0b661d074a7f9a9c42f143304c4807084f3cea.tar.bz2
rockbox-8c0b661d074a7f9a9c42f143304c4807084f3cea.zip
Fix some issues with generation of plugin API documentation + make it more themeable
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18750 a1c6a512-1295-4272-9138-f99709370657
Diffstat (limited to 'utils/rockbox_api/section.tpl')
-rw-r--r--utils/rockbox_api/section.tpl50
1 files changed, 50 insertions, 0 deletions
diff --git a/utils/rockbox_api/section.tpl b/utils/rockbox_api/section.tpl
new file mode 100644
index 0000000000..874703cb9c
--- /dev/null
+++ b/utils/rockbox_api/section.tpl
@@ -0,0 +1,50 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+<link href="layout.css" rel="stylesheet" type="text/css" />
+<title>Plugin API - %GROUP_NAME%</title>
+</head>
+
+<body>
+ <div id="menu">%MENU%</div>
+ <div id="content">
+ <a link="top"></a>
+ <h2>%GROUP_NAME%</h2>
+ <span class="group">
+ %FUNCTION_START%
+ <a id="%FUNCTION_NAME%"></a>
+ <h3>%FUNCTION%</h3>
+
+ %DESCRIPTION_START%
+ %FUNCTION_DESCRIPTION%
+ <br /><br />
+ %DESCRIPTION_END%
+
+ %PARAMETER_START%
+ <span class="extra">Parameters:</span>
+ <dl>
+ %PARAMETERS_START%
+ <dt>%PARAM1%</dt><dd>%PARAM2%</dd>
+ %PARAMETERS_END%
+ </dl>
+ %PARAMETER_END%
+
+ %RETURN_START%
+ <span class="extra">Returns:</span> %RETURN%<br /><br />
+ %RETURN_END%
+
+ %CONDITIONS_START%
+ <span class="extra">Conditions:</span> %CONDITIONS%<br /><br />
+ %CONDITIONS_END%
+
+ %SEE_START%
+ <span class="see">Also see %SEE%</span><br /><br />
+ %SEE_END%
+
+ <a href="#top" class="top">To top</a><hr />
+
+ %FUNCTION_END%
+ </span>
+ </div>
+</body>
+</html> \ No newline at end of file