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     <refpurpose>Utilities for waffle enums</refpurpose>
  27   </refnamediv>
  28
  29   <refentryinfo>
  30     <title>Waffle Manual</title>
  31     <productname>waffle</productname>
  32     <xi:include href="common/author-chad.versace.xml"/>
  33     <xi:include href="common/copyright.xml"/>
  34     <xi:include href="common/legalnotice.xml"/>
  35   </refentryinfo>
  36
  37   <refsynopsisdiv>
  38
  39     <funcsynopsis language="C">
  40
  41       <funcsynopsisinfo>
  42 #include &lt;waffle.h&gt;
  43
  44 enum waffle_enum {...};
  45       </funcsynopsisinfo>
  46
  47       <funcprototype>
  48         <funcdef>const char* <function>waffle_enum_to_string</function></funcdef>
  49         <paramdef>int32_t <parameter>e</parameter></paramdef>
  50       </funcprototype>
  51
  52     </funcsynopsis>
  53   </refsynopsisdiv>
  54
  55   <refsect1>
  56     <title>Description</title>
  57
  58     <variablelist>
  59
  60       <varlistentry>
  61         <term><function>waffle_enum_to_string()</function></term>
  62         <listitem>
  63           <para>
  64             Convert an <type>waffle_enum</type> token to a string.
  65             For example, convert <constant>WAFFLE_DONT_CARE</constant> to <code>"WAFFLE_DONT_CARE"</code>.
  66             Return null if the token is not a valid <type>waffle_enum</type>.
  67           </para>
  68           <para>
  69             This function always sets the error code to <constant>WAFFLE_NO_ERROR</constant>.
  70             It can be called before waffle has been successfully initialized with
  71             <citerefentry><refentrytitle><function>waffle_init</function></refentrytitle><manvolnum>3</manvolnum></citerefentry>
  72           </para>
  73         </listitem>
  74       </varlistentry>
  75
  76     </variablelist>
  77
  78   </refsect1>
  79
  80   <xi:include href="common/issues.xml"/>
  81
  82   <refsect1>
  83     <title>See Also</title>
  84     <para>
  85       <citerefentry><refentrytitle>waffle</refentrytitle><manvolnum>7</manvolnum></citerefentry>
  86     </para>
  87   </refsect1>
  88
  89 </refentry>
  90
  91 <!--
  92 vim:tw=120 et ts=2 sw=2:
  93 -->