diff options
| author | Emil Velikov <emil.l.velikov@gmail.com> | 2015-02-16 22:41:23 +0000 |
|---|---|---|
| committer | Chad Versace <chad.versace@intel.com> | 2015-02-17 11:20:31 -0800 |
| commit | f3d99bd3a5128b0d73fbc6362a884d68e4ad8a22 (patch) | |
| tree | 4402cc46e3c399fe6da013383b909730ba6d80f3 | |
| parent | d15a83a453c87b445d8abf19d82668bca1a389d4 (diff) | |
man: fix waffle_teardown description
Seems like I've used a bit too many tags, which caused some issues while
generating the man/html page.
Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Reviewed-by: Chad Versace <chad.versace@intel.com>
| -rw-r--r-- | man/waffle_teardown.3.xml | 39 |
1 files changed, 18 insertions, 21 deletions
diff --git a/man/waffle_teardown.3.xml b/man/waffle_teardown.3.xml index 69b18e9..154478c 100644 --- a/man/waffle_teardown.3.xml +++ b/man/waffle_teardown.3.xml @@ -46,27 +46,24 @@ <refsect1> <title>Description</title> - <term><function>waffle_teardown()</function></term> - <listitem> - <para> - Feature test macro: <code>WAFFLE_API_VERSION >= 0x0106</code>. - (See <citerefentry><refentrytitle>waffle_feature_test_macros</refentrytitle><manvolnum>7</manvolnum></citerefentry>). - </para> - <para> - Tears down the per-process global state of the waffle library. - </para> - <para> - А call to <function>waffle_teardown()</function> can fail. In the case it does the caller is advised - to use <function>waffle_error_get_info</function>, <function>waffle_error_get_code</function> - and/or <function>waffle_error_to_string</function> to retrieve the error. - - In case of an error that differs from <errorcode>WAFFLE_ERROR_NOT_INITIALIZED</errorcode> the caller - should not use the Waffle API as the global state is likely to be in an undetermined/corrupt. - - In the case of <errorcode>WAFFLE_ERROR_NOT_INITIALIZED</errorcode> one should call - <function>waffle_init()</function> prior to reusing Waffle. - </para> - </listitem> + <para> + Feature test macro: <code>WAFFLE_API_VERSION >= 0x0106</code>. + (See <citerefentry><refentrytitle>waffle_feature_test_macros</refentrytitle><manvolnum>7</manvolnum></citerefentry>). + </para> + <para> + <function>waffle_teardown()</function> tears down the per-process global state of the waffle library. + </para> + <para> + А call to <function>waffle_teardown()</function> can fail. In the case it does the caller is advised + to use <function>waffle_error_get_info</function>, <function>waffle_error_get_code</function> + and/or <function>waffle_error_to_string</function> to retrieve the error. + + In case of an error that differs from <errorcode>WAFFLE_ERROR_NOT_INITIALIZED</errorcode> the caller + should not use the Waffle API as the global state is likely to be in an undetermined/corrupt. + + In the case of <errorcode>WAFFLE_ERROR_NOT_INITIALIZED</errorcode> one should call + <function>waffle_init()</function> prior to reusing Waffle. + </para> </refsect1> <refsect1> |