From c626f47cb5e9624730a4d45ea4afb4468148b751 Mon Sep 17 00:00:00 2001 From: Maurus Cuelenaere Date: Thu, 9 Oct 2008 12:24:57 +0000 Subject: Add Rockbox layout to plugin API documentation git-svn-id: svn://svn.rockbox.org/rockbox/trunk@18754 a1c6a512-1295-4272-9138-f99709370657 --- docs/PLUGIN_API.new | 4 +- utils/rockbox_api/index.tpl | 93 ++++++++++++++++++++++---- utils/rockbox_api/layout.css | 43 ++++++------ utils/rockbox_api/section.tpl | 150 ++++++++++++++++++++++++++++++------------ 4 files changed, 212 insertions(+), 78 deletions(-) diff --git a/docs/PLUGIN_API.new b/docs/PLUGIN_API.new index 3388fa9412..02e9c8c157 100644 --- a/docs/PLUGIN_API.new +++ b/docs/PLUGIN_API.new @@ -2221,8 +2221,8 @@ int snprintf(char *buf, size_t size, const char *fmt, ...) ATTRIBUTE_PRINTF(3, 4 \param buf \param size \param fmt - \return the number of characters printed or that would have been printed if the output was truncated (not including the trailing '\0') upon success - \description Write a formatted string =fmt= in buffer =buf= of size =size= (including the trailing '\0'). These support %c, %s, %d and %x only with the width and zero padding flag only. + \return the number of characters printed or that would have been printed if the output was truncated (not including the trailing NULL character) upon success + \description Write a formatted string =fmt= in buffer =buf= of size =size= (including the trailing NULL character). These support %c, %s, %d and %x only with the width and zero padding flag only. int sound_default(int setting) \group sound diff --git a/utils/rockbox_api/index.tpl b/utils/rockbox_api/index.tpl index ccbd5965ad..7412b150f1 100644 --- a/utils/rockbox_api/index.tpl +++ b/utils/rockbox_api/index.tpl @@ -2,22 +2,89 @@ - Plugin API - INDEX + + + Rockbox Plugin API - INDEX + -

Plugin API reference

- + + + + + +
+
+
+ Rockbox.org home +
+
+
+ Downloads +
+ releases
+ current build
+ extras +
+ Documentation +
+ manual
+ wiki
+ docs index +
+ Support +
+ mailing lists
+ IRC
+ + forums +
+ Tracker +
+ bugs
+ patches
+  requests
+
+ Search +
+ +
+
+ +
+
+
+
+ + +
+

+ + + + + + + + + +
+
+ 		+

Plugin API reference

+
    + %GROUP_START% +
  • %GROUP_NAME% + +
    • + %GROUP_END% +
+
\ No newline at end of file diff --git a/utils/rockbox_api/layout.css b/utils/rockbox_api/layout.css index 09e7391197..09aaff11a3 100644 --- a/utils/rockbox_api/layout.css +++ b/utils/rockbox_api/layout.css @@ -1,77 +1,77 @@ -body +.plugincontent { font-family: Verdana; } -li +.plugincontent li { font-size: 10px; } -code +.plugincontent code { color: #00A; } -.see, .see a +.plugincontent .see, .plugincontent .see a { color: #559; } -.group +.plugincontent .group { font-size: 12px; } -.group h3 +.plugincontent .group h3 { font-size: 14px; } -h2 +.plugincontent h2 { color: #D11; } -a +.plugincontent a { color: blue; } -a:hover +.plugincontent a:hover { color: red; } -.top +.plugincontent .top { font-size: 10px; color: green; } -.extra +.plugincontent .extra { font-weight: bold; color: #992; } -dl +.plugincontent dl { border-left: 1px solid #CCC; padding-left: 10px; } -dt, dd +.plugincontent dt, .plugincontent dd { font-style: normal; } -dd +.plugincontent dd { margin-left: 12em; } -dt +.plugincontent dt { clear: left; display: block; @@ -80,29 +80,28 @@ dt width: 12em; } -hr +.plugincontent hr { border: 1px solid #CCCCCC; margin: 1em 0; } -#content +.plugincontent #content { margin-left: 14em; margin-right: 1em; padding: 0; } -#menu +.plugincontent #menu { - position: fixed; - top: 0px; - left: 0px; + position: absolute; + left: 120px; /* I hate IE */ width: 14em; padding: 0; } -#menu ul +.plugincontent #menu ul { padding-left: 1em; } \ No newline at end of file diff --git a/utils/rockbox_api/section.tpl b/utils/rockbox_api/section.tpl index 874703cb9c..77304c1a65 100644 --- a/utils/rockbox_api/section.tpl +++ b/utils/rockbox_api/section.tpl @@ -1,50 +1,118 @@ - -Plugin API - %GROUP_NAME% + + + + Rockbox Plugin API - %GROUP_NAME% + - -
- -

%GROUP_NAME%

- - %FUNCTION_START% - -

%FUNCTION%

- - %DESCRIPTION_START% - %FUNCTION_DESCRIPTION% -

- %DESCRIPTION_END% - - %PARAMETER_START% - Parameters: -
- %PARAMETERS_START% -
%PARAM1%
%PARAM2%
- %PARAMETERS_END% -
- %PARAMETER_END% - - %RETURN_START% - Returns: %RETURN%

- %RETURN_END% - - %CONDITIONS_START% - Conditions: %CONDITIONS%

- %CONDITIONS_END% - - %SEE_START% - Also see %SEE%

- %SEE_END% - - To top
- - %FUNCTION_END% - + + + + + +
+
+
+ + Rockbox.org home
+
+
+ Downloads +
+ releases
+ current build
+ extras +
+ Documentation + +
+ manual
+ wiki
+ docs index +
+ Support +
+ mailing lists
+ IRC
+ + forums +
+ Tracker +
+ bugs
+ patches
+  requests
+
+ Search +
+ +
+
+ +
+
+
+
+ + +
+

+ + + + + + + + + +
+
+ 		+ +
+ +

%GROUP_NAME%

+ + %FUNCTION_START% + +

%FUNCTION%

+ + %DESCRIPTION_START% + %FUNCTION_DESCRIPTION% +

+ %DESCRIPTION_END% + + %PARAMETER_START% + Parameters: +
+ %PARAMETERS_START% +
%PARAM1%
%PARAM2%
+ %PARAMETERS_END% +
+ %PARAMETER_END% + + %RETURN_START% + Returns: %RETURN%

+ %RETURN_END% + + %CONDITIONS_START% + Conditions: %CONDITIONS%

+ %CONDITIONS_END% + + %SEE_START% + Also see %SEE%

+ %SEE_END% + + To top
+ %FUNCTION_END% + +
+
\ No newline at end of file -- cgit v1.2.3