man/waffle_enum.3.xml

   1 <?xml version='1.0'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <!--
   6   Copyright Intel 2012
   7
   8   This manual page is licensed under the Creative Commons Attribution-ShareAlike 3.0 United States License (CC BY-SA 3.0
   9   US). To view a copy of this license, visit http://creativecommons.org.license/by-sa/3.0/us.
  10 -->
  11
  12 <refentry
  13     id="waffle_enum"
  14     xmlns:xi="http://www.w3.org/2001/XInclude">
  15
  16   <!-- See http://www.docbook.org/tdg/en/html/refentry.html. -->
  17
  18   <refmeta>
  19     <refentrytitle>waffle_enum</refentrytitle>
  20     <manvolnum>3</manvolnum>
  21   </refmeta>
  22
  23   <refnamediv>
  24     <refname>waffle_enum</refname>
  25     <refname>waffle_enum_to_string</refname>
  26   </refnamediv>
  27
  28   <refentryinfo>
  29     <title>Waffle Manual</title>
  30     <productname>waffle</productname>
  31     <xi:include href="common/author-chad.versace.xml"/>
  32     <xi:include href="common/copyright.xml"/>
  33     <xi:include href="common/legalnotice.xml"/>
  34   </refentryinfo>
  35
  36   <refsynopsisdiv>
  37
  38     <funcsynopsis language="C">
  39
  40       <funcsynopsisinfo>
  41 #include &lt;waffle.h&gt;
  42
  43 enum waffle_enum {...};
  44       </funcsynopsisinfo>
  45
  46       <funcprototype>
  47         <funcdef>const char* <function>waffle_enum_to_string</function></funcdef>
  48         <paramdef>int32_t <parameter>e</parameter></paramdef>
  49       </funcprototype>
  50
  51     </funcsynopsis>
  52   </refsynopsisdiv>
  53
  54   <refsect1>
  55     <title>Description</title>
  56
  57     <variablelist>
  58
  59       <varlistentry>
  60         <term><function>waffle_enum_to_string()</function></term>
  61         <listitem>
  62           <para>
  63             Convert an <type>waffle_enum</type> token to a string.
  64             For example, convert <constant>WAFFLE_DONT_CARE</constant> to <code>"WAFFLE_DONT_CARE"</code>.
  65             Return null if the token is not a valid <type>waffle_enum</type>.
  66           </para>
  67           <para>
  68             This function always sets the error code to <constant>WAFFLE_NO_ERROR</constant>.
  69             It can be called before waffle has been successfully initialized with
  70             <citerefentry><refentrytitle><function>waffle_init</function></refentrytitle><manvolnum>3</manvolnum></citerefentry>
  71           </para>
  72         </listitem>
  73       </varlistentry>
  74
  75     </variablelist>
  76
  77   </refsect1>
  78
  79   <xi:include href="common/issues.xml"/>
  80
  81   <refsect1>
  82     <title>See Also</title>
  83     <para>
  84       <citerefentry><refentrytitle>waffle</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  85     </para>
  86   </refsect1>
  87
  88 </refentry>
  89
  90 <!--
  91 vim:tw=120 et ts=2 sw=2:
  92 -->