diff options
author | Chad Versace <chad.versace@linux.intel.com> | 2012-10-17 19:20:06 -0700 |
---|---|---|
committer | Chad Versace <chad.versace@linux.intel.com> | 2012-10-18 06:24:48 -0700 |
commit | 14b27a1381884aa4c19e65febd1e23c8f2141cbd (patch) | |
tree | 204fcc90dabd679ee2867e14604e32317db46da0 /man | |
parent | d1b8df61c708371aa32e5b728fdc7cadbcf952bb (diff) |
man: Improve style of <term>
Reformat each multiline <term> to be singleline. It makes the XML easier
to read.
Signed-off-by: Chad Versace <chad.versace@linux.intel.com>
Diffstat (limited to 'man')
-rw-r--r-- | man/waffle_attrib_list.3.xml | 16 | ||||
-rw-r--r-- | man/waffle_config.3.xml | 44 | ||||
-rw-r--r-- | man/waffle_context.3.xml | 16 | ||||
-rw-r--r-- | man/waffle_display.3.xml | 20 | ||||
-rw-r--r-- | man/waffle_dl.3.xml | 8 | ||||
-rw-r--r-- | man/waffle_enum.3.xml | 8 | ||||
-rw-r--r-- | man/waffle_error.3.xml | 68 | ||||
-rw-r--r-- | man/waffle_gl_misc.3.xml | 12 | ||||
-rw-r--r-- | man/waffle_init.3.xml | 40 | ||||
-rw-r--r-- | man/waffle_window.3.xml | 26 |
10 files changed, 64 insertions, 194 deletions
diff --git a/man/waffle_attrib_list.3.xml b/man/waffle_attrib_list.3.xml index 0b6e66f..5355d29 100644 --- a/man/waffle_attrib_list.3.xml +++ b/man/waffle_attrib_list.3.xml @@ -91,9 +91,7 @@ <variablelist> <varlistentry> - <term> - <function>waffle_attrib_list_length()</function> - </term> + <term><function>waffle_attrib_list_length()</function></term> <listitem> <para> Return the number of key/value pairs in the list. @@ -102,9 +100,7 @@ </varlistentry> <varlistentry> - <term> - <function>waffle_attrib_list_get()</function> - </term> + <term><function>waffle_attrib_list_get()</function></term> <listitem> <para> Get the <parameter>value</parameter> associated with <parameter>key</parameter>. If the list does not @@ -115,9 +111,7 @@ </varlistentry> <varlistentry> - <term> - <function>waffle_attrib_list_get_with_default()</function> - </term> + <term><function>waffle_attrib_list_get_with_default()</function></term> <listitem> <para> Equivalent to <function>waffle_attrib_list_get()</function> except that if the list does not contain the @@ -127,9 +121,7 @@ </varlistentry> <varlistentry> - <term> - <function>waffle_attrib_list_update()</function> - </term> + <term><function>waffle_attrib_list_update()</function></term> <listitem> <para> Update the <parameter>value</parameter> associated with <parameter>key</parameter>. diff --git a/man/waffle_config.3.xml b/man/waffle_config.3.xml index 752eca7..7cb6543 100644 --- a/man/waffle_config.3.xml +++ b/man/waffle_config.3.xml @@ -71,9 +71,7 @@ struct waffle_config; <variablelist> <varlistentry> - <term> - <type>struct waffle_config</type> - </term> + <term><type>struct waffle_config</type></term> <listitem> <para> An opaque type. @@ -82,9 +80,7 @@ struct waffle_config; </varlistentry> <varlistentry> - <term> - <function>waffle_config_choose()</function> - </term> + <term><function>waffle_config_choose()</function></term> <listitem> <para> Choose a config on <parameter>display</parameter> that satifisfies the set of attributes specified by @@ -103,9 +99,7 @@ struct waffle_config; </varlistentry> <varlistentry> - <term> - <function>waffle_config_destroy()</function> - </term> + <term><function>waffle_config_destroy()</function></term> <listitem> <para> Destroy the config and release its memory. @@ -114,9 +108,7 @@ struct waffle_config; </varlistentry> <varlistentry> - <term> - <function>waffle_config_get_native()</function> - </term> + <term><function>waffle_config_get_native()</function></term> <listitem> <para> Get the config's underlying native objects. Use @@ -171,9 +163,7 @@ struct waffle_config; <variablelist> <varlistentry> - <term> - <constant>WAFFLE_CONTEXT_API</constant> - </term> + <term><constant>WAFFLE_CONTEXT_API</constant></term> <listitem> <para> This is a required attribute; it has no default value. It must be one of: @@ -286,9 +276,7 @@ struct waffle_config; </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_CONTEXT_PROFILE</constant> - </term> + <term><constant>WAFFLE_CONTEXT_PROFILE</constant></term> <listitem> <para> The default and supported values for <constant>WAFFLE_CONTEXT_PROFILE</constant> depend on the native @@ -338,9 +326,7 @@ struct waffle_config; </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_DOUBLE_BUFFERED</constant> - </term> + <term><constant>WAFFLE_DOUBLE_BUFFERED</constant></term> <listitem> <para> The valid values are true and false. The default is true. This attribute specifies if a surface created with @@ -350,9 +336,7 @@ struct waffle_config; </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ACCUM_BUFFER</constant> - </term> + <term><constant>WAFFLE_ACCUM_BUFFER</constant></term> <listitem> <para> The valid values are true and false. The default is false. This attribute specifies if a surface created with @@ -381,16 +365,12 @@ struct waffle_config; <variablelist> <varlistentry> - <term> - <function>waffle_config_choose()</function> - </term> + <term><function>waffle_config_choose()</function></term> <listitem> <variablelist> <varlistentry> - <term> - <errorcode>WAFFLE_ERROR_BAD_ATTRIBUTE</errorcode> - </term> + <term><errorcode>WAFFLE_ERROR_BAD_ATTRIBUTE</errorcode></term> <listitem> <para> An item in <parameter>attrib_list</parameter> is unrecognized or has an invalid value, or a required @@ -400,9 +380,7 @@ struct waffle_config; </varlistentry> <varlistentry> - <term> - <errorcode>WAFFLE_ERROR_UNSUPPORTED_ON_PLATFORM</errorcode> - </term> + <term><errorcode>WAFFLE_ERROR_UNSUPPORTED_ON_PLATFORM</errorcode></term> <listitem> <para> The attribute list is valid, but platform does not support the requested config. For example, diff --git a/man/waffle_context.3.xml b/man/waffle_context.3.xml index 2db5063..6f5ee1d 100644 --- a/man/waffle_context.3.xml +++ b/man/waffle_context.3.xml @@ -71,9 +71,7 @@ struct waffle_context; <variablelist> <varlistentry> - <term> - <type>struct waffle_context</type> - </term> + <term><type>struct waffle_context</type></term> <listitem> <para> An opaque type. @@ -82,9 +80,7 @@ struct waffle_context; </varlistentry> <varlistentry> - <term> - <function>waffle_context_create()</function> - </term> + <term><function>waffle_context_create()</function></term> <listitem> <para> Create a context for OpenGL rendering with the properties specified by <parameter>config</parameter>. @@ -102,9 +98,7 @@ struct waffle_context; </varlistentry> <varlistentry> - <term> - <function>waffle_context_destroy()</function> - </term> + <term><function>waffle_context_destroy()</function></term> <listitem> <para> Destroy the context and release its memory. @@ -113,9 +107,7 @@ struct waffle_context; </varlistentry> <varlistentry> - <term> - <function>waffle_context_get_native()</function> - </term> + <term><function>waffle_context_get_native()</function></term> <listitem> <para> Get the context's underlying native objects. Use diff --git a/man/waffle_display.3.xml b/man/waffle_display.3.xml index c13bddb..9ee5c02 100644 --- a/man/waffle_display.3.xml +++ b/man/waffle_display.3.xml @@ -77,9 +77,7 @@ struct waffle_display; <variablelist> <varlistentry> - <term> - <type>struct waffle_display</type> - </term> + <term><type>struct waffle_display</type></term> <listitem> <para> An opaque type. @@ -88,9 +86,7 @@ struct waffle_display; </varlistentry> <varlistentry> - <term> - <function>waffle_display_connect()</function> - </term> + <term><function>waffle_display_connect()</function></term> <listitem> <para> Connect to a display. The interpretation of <parameter>name</parameter> differs according to the platform @@ -118,9 +114,7 @@ struct waffle_display; </varlistentry> <varlistentry> - <term> - <function>waffle_display_disconnect()</function> - </term> + <term><function>waffle_display_disconnect()</function></term> <listitem> <para> Disconnect from the <type>waffle_display</type> and release it's memory. All pointers to waffle objects that @@ -130,9 +124,7 @@ struct waffle_display; </varlistentry> <varlistentry> - <term> - <function>waffle_display_supports_context_api()</function> - </term> + <term><function>waffle_display_supports_context_api()</function></term> <listitem> <para> Check if the display is capable of creating @@ -145,9 +137,7 @@ struct waffle_display; </varlistentry> <varlistentry> - <term> - <function>waffle_display_get_native()</function> - </term> + <term><function>waffle_display_get_native()</function></term> <listitem> <para> Get the display's underlying native objects. Use diff --git a/man/waffle_dl.3.xml b/man/waffle_dl.3.xml index 04ae3bc..43bcaaf 100644 --- a/man/waffle_dl.3.xml +++ b/man/waffle_dl.3.xml @@ -76,9 +76,7 @@ <variablelist> <varlistentry> - <term> - <function>waffle_dl_can_open()</function> - </term> + <term><function>waffle_dl_can_open()</function></term> <listitem> <para> Test if a dynamic library can be opened. @@ -87,9 +85,7 @@ </varlistentry> <varlistentry> - <term> - <function>waffle_dl_sym()</function> - </term> + <term><function>waffle_dl_sym()</function></term> <listitem> <para> Get a <parameter>symbol</parameter> from a dynamic library. diff --git a/man/waffle_enum.3.xml b/man/waffle_enum.3.xml index 2779f78..152ee1c 100644 --- a/man/waffle_enum.3.xml +++ b/man/waffle_enum.3.xml @@ -58,9 +58,7 @@ enum waffle_enum {...}; <variablelist> <varlistentry> - <term> - <function>waffle_enum_to_string()</function> - </term> + <term><function>waffle_enum_to_string()</function></term> <listitem> <para> Convert an <type>waffle_enum</type> token to a string. @@ -76,9 +74,7 @@ enum waffle_enum {...}; </varlistentry> <varlistentry> - <term> - <type>enum waffle_enum</type> - </term> + <term><type>enum waffle_enum</type></term> <listitem> <para> For reference, below is the complete list of waffle's non-error enums. diff --git a/man/waffle_error.3.xml b/man/waffle_error.3.xml index 503cb68..7b259fe 100644 --- a/man/waffle_error.3.xml +++ b/man/waffle_error.3.xml @@ -87,9 +87,7 @@ struct waffle_error_info { <variablelist> <varlistentry> - <term> - <type>struct waffle_error_info</type> - </term> + <term><type>struct waffle_error_info</type></term> <listitem> <para> This struct contains the user-visible portion of waffle's thread-local error state. @@ -109,9 +107,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <function>waffle_error_to_string()</function> - </term> + <term><function>waffle_error_to_string()</function></term> <listitem> <para> Convert a <type>waffle_error</type> token to a string. @@ -126,9 +122,7 @@ struct waffle_error_info { <varlistentry> - <term> - <function>waffle_error_get_info()</function> - </term> + <term><function>waffle_error_get_info()</function></term> <listitem> <para> Get information about the current thread's error state. @@ -144,9 +138,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <function>waffle_error_get_code()</function> - </term> + <term><function>waffle_error_get_code()</function></term> <listitem> <para> Get the current thread's error code. Calling this function is equivalent to obtaining the error code with @@ -159,9 +151,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <type>enum waffle_error</type> - </term> + <term><type>enum waffle_error</type></term> <listitem> <para> For reference, below is the complete list of waffle's error codes. @@ -169,9 +159,7 @@ struct waffle_error_info { <variablelist> <varlistentry> - <term> - <constant>WAFFLE_NO_ERROR</constant> = 0x00 - </term> + <term><constant>WAFFLE_NO_ERROR</constant> = 0x00</term> <listitem> <para> The function succeeded. @@ -180,9 +168,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ERROR_FATAL</constant> = 0x01 - </term> + <term><constant>WAFFLE_ERROR_FATAL</constant> = 0x01</term> <listitem> <para> Waffle encountered a fatal error. All future waffle calls result in @@ -192,9 +178,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ERROR_UNKNOWN</constant> = 0x02 - </term> + <term><constant>WAFFLE_ERROR_UNKNOWN</constant> = 0x02</term> <listitem> <para> Waffle encountered an error for which it lacks an error code. This is @@ -206,9 +190,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ERROR_INTERNAL</constant> = 0x03 - </term> + <term><constant>WAFFLE_ERROR_INTERNAL</constant> = 0x03</term> <listitem> <para> You found a bug in waffle. Please report it. The error message, obtained by @@ -218,9 +200,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ERROR_BAD_ALLOC</constant> = 0x04 - </term> + <term><constant>WAFFLE_ERROR_BAD_ALLOC</constant> = 0x04</term> <listitem> <para> Waffle failed to allocate memory. @@ -229,9 +209,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ERROR_NOT_INITIALIZED</constant> = 0x05 - </term> + <term><constant>WAFFLE_ERROR_NOT_INITIALIZED</constant> = 0x05</term> <listitem> <para> The failed function requires waffle to be initialized with @@ -241,9 +219,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ERROR_ALREADY_INITIALIZED</constant> = 0x06 - </term> + <term><constant>WAFFLE_ERROR_ALREADY_INITIALIZED</constant> = 0x06</term> <listitem> <para> If waffle has already been initialized by a successful call to @@ -254,9 +230,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ERROR_BAD_ATTRIBUTE</constant> = 0x08 - </term> + <term><constant>WAFFLE_ERROR_BAD_ATTRIBUTE</constant> = 0x08</term> <listitem> <para> An unrecognized attribute name or attribute value was passed in an @@ -266,9 +240,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ERROR_BAD_PARAMETER</constant> = 0x10 - </term> + <term><constant>WAFFLE_ERROR_BAD_PARAMETER</constant> = 0x10</term> <listitem> <para> The failed function was passed an invalid argument. @@ -277,9 +249,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ERROR_BAD_DISPLAY_MATCH</constant> = 0x11 - </term> + <term><constant>WAFFLE_ERROR_BAD_DISPLAY_MATCH</constant> = 0x11</term> <listitem> <para> The waffle objects passed to the failed function belong to different @@ -289,9 +259,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ERROR_UNSUPPORTED_ON_PLATFORM</constant> = 0x12 - </term> + <term><constant>WAFFLE_ERROR_UNSUPPORTED_ON_PLATFORM</constant> = 0x12</term> <listitem> <para> The requested action is unsupported on the current system or platform, but is otherwise valid. @@ -304,9 +272,7 @@ struct waffle_error_info { </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_ERROR_BUILT_WITHOUT_SUPPORT</constant> = 0x13 - </term> + <term><constant>WAFFLE_ERROR_BUILT_WITHOUT_SUPPORT</constant> = 0x13</term> <listitem> <para> Waffle was built without support for the requested action. diff --git a/man/waffle_gl_misc.3.xml b/man/waffle_gl_misc.3.xml index b0fbad1..ca3e82b 100644 --- a/man/waffle_gl_misc.3.xml +++ b/man/waffle_gl_misc.3.xml @@ -70,9 +70,7 @@ <variablelist> <varlistentry> - <term> - <function>waffle_is_extension_in_string()</function> - </term> + <term><function>waffle_is_extension_in_string()</function></term> <listitem> <para> Check if an extension is contained in a GL-style extension string. @@ -90,9 +88,7 @@ </varlistentry> <varlistentry> - <term> - <function>waffle_make_current()</function> - </term> + <term><function>waffle_make_current()</function></term> <listitem> <para> Bind the given <parameter>window</parameter> and <parameter>context</parameter> for rendering on the current @@ -107,9 +103,7 @@ </varlistentry> <varlistentry> - <term> - <function>waffle_get_proc_address()</function> - </term> + <term><function>waffle_get_proc_address()</function></term> <listitem> <para> On GLX, this redirects to <function>glXGetProcAddress</function>. On EGL, this redirects to diff --git a/man/waffle_init.3.xml b/man/waffle_init.3.xml index 8d48523..0c320ed 100644 --- a/man/waffle_init.3.xml +++ b/man/waffle_init.3.xml @@ -72,9 +72,7 @@ <variablelist> <varlistentry> - <term> - <constant>WAFFLE_PLATFORM</constant> - </term> + <term><constant>WAFFLE_PLATFORM</constant></term> <listitem> <para> This attribute is required. Possible values are: @@ -82,9 +80,7 @@ <variablelist> <varlistentry> - <term> - <constant>WAFFLE_PLATFORM_ANDROID</constant> - </term> + <term><constant>WAFFLE_PLATFORM_ANDROID</constant></term> <listitem> <para> [Android] Use EGL on Android. @@ -93,9 +89,7 @@ </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_PLATFORM_GBM</constant> - </term> + <term><constant>WAFFLE_PLATFORM_GBM</constant></term> <listitem> <para> [Linux] Use EGL with GBM, the "Generic Buffer Manager" provided by libgbm. This platform is @@ -105,9 +99,7 @@ </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_PLATFORM_CGL</constant> - </term> + <term><constant>WAFFLE_PLATFORM_CGL</constant></term> <listitem> <para> [MacOS] Use CGL to create the @@ -121,9 +113,7 @@ </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_PLATFORM_GLX</constant> - </term> + <term><constant>WAFFLE_PLATFORM_GLX</constant></term> <listitem> <para> [Linux only, MacOS not yet supported] @@ -131,9 +121,7 @@ </listitem> </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_PLATFORM_WAYLAND</constant> - </term> + <term><constant>WAFFLE_PLATFORM_WAYLAND</constant></term> <listitem> <para> [Linux] Use EGL with the Wayland display server. @@ -141,9 +129,7 @@ </listitem> </varlistentry> <varlistentry> - <term> - <constant>WAFFLE_PLATFORM_X11_EGL</constant> - </term> + <term><constant>WAFFLE_PLATFORM_X11_EGL</constant></term> <listitem> <para> [Linux] Use EGL with the X11 display server. @@ -176,9 +162,7 @@ <variablelist> <varlistentry> - <term> - <errorcode>WAFFLE_ERROR_ALREADY_INITIALIZED</errorcode> - </term> + <term><errorcode>WAFFLE_ERROR_ALREADY_INITIALIZED</errorcode></term> <listitem> <para> Waffle has already been initialized with a successfull call to <function>waffle_init()</function>. @@ -187,9 +171,7 @@ </varlistentry> <varlistentry> - <term> - <errorcode>WAFFLE_ERROR_BAD_ATTRIBUTE</errorcode> - </term> + <term><errorcode>WAFFLE_ERROR_BAD_ATTRIBUTE</errorcode></term> <listitem> <para> An item in <parameter>attrib_list</parameter> is unrecognized or has an invalid value, or a required @@ -199,9 +181,7 @@ </varlistentry> <varlistentry> - <term> - <errorcode>WAFFLE_ERROR_BUILT_WITHOUT_SUPPORT</errorcode> - </term> + <term><errorcode>WAFFLE_ERROR_BUILT_WITHOUT_SUPPORT</errorcode></term> <listitem> <para> Waffle was built without support for the requested attribute. diff --git a/man/waffle_window.3.xml b/man/waffle_window.3.xml index 5144d3a..1da7eef 100644 --- a/man/waffle_window.3.xml +++ b/man/waffle_window.3.xml @@ -84,20 +84,14 @@ struct waffle_window; <variablelist> <varlistentry> - <term> - <type>struct waffle_window</type> - </term> - <listitem> - <para> + <term><type>struct waffle_window</type></term><listitem><para> An opaque type. </para> </listitem> </varlistentry> <varlistentry> - <term> - <function>waffle_window_create()</function> - </term> + <term><function>waffle_window_create()</function></term> <listitem> <para> Create a window with the properties specified by <parameter>config</parameter>. @@ -110,9 +104,7 @@ struct waffle_window; </varlistentry> <varlistentry> - <term> - <function>waffle_window_destroy()</function> - </term> + <term><function>waffle_window_destroy()</function></term> <listitem> <para> Destroy the window and release its memory. @@ -121,9 +113,7 @@ struct waffle_window; </varlistentry> <varlistentry> - <term> - <function>waffle_window_show()</function> - </term> + <term><function>waffle_window_show()</function></term> <listitem> <para> Show the window on the display. If the window is already shown, or if the native platform does not support @@ -133,9 +123,7 @@ struct waffle_window; </varlistentry> <varlistentry> - <term> - <function>waffle_window_swap_buffers()</function> - </term> + <term><function>waffle_window_swap_buffers()</function></term> <listitem> <para> If the window is double-buffered, then implicitly call <function>glFlush()</function> and post the contents @@ -149,9 +137,7 @@ struct waffle_window; </varlistentry> <varlistentry> - <term> - <function>waffle_window_get_native()</function> - </term> + <term><function>waffle_window_get_native()</function></term> <listitem> <para> Get the window's underlying native objects. Use |