<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Documentation</title>
<link rel="stylesheet" type="text/css" href="style.css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Programming with gtkmm 3">
<link rel="up" href="chapter-wrapping-c-libraries.html" title="Appendix G. Wrapping C Libraries with gmmproc">
<link rel="prev" href="sec-wrapping-problems.html" title="Problems in the C API.">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">Documentation</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="sec-wrapping-problems.html"><img src="icons/prev.png" alt="Prev"></a> </td>
<th width="60%" align="center">Appendix G. Wrapping C Libraries with gmmproc</th>
<td width="20%" align="right"> </td>
</tr>
</table>
<hr>
</div>
<div class="sect1">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="sec-wrapping-documentation"></a>Documentation</h2></div></div></div>
<p>In general, gtkmm-style projects use Doxygen, which reads specially formatted C++ comments and generates HTML documentation. You may write these doxygen comments directly in the header files.</p>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="wrapping-reusing-c-documentation"></a>Reusing C documentation</h3></div></div></div>
<p>You might wish to reuse documentation that exists for the C library that
you are wrapping. GTK-style C libraries typically use gtk-doc and therefore
have source code comments formatted for gtk-doc and some extra documentation
in .sgml and .xml files. The docextract_to_xml.py script, from glibmm's
<code class="filename">tools/defs_gen</code> directory, can read these files and
generate an .xml file that <span class="command"><strong>gmmproc</strong></span> can use to generate
doxygen comments. <span class="command"><strong>gmmproc</strong></span> will even try to transform the
documentation to make it more appropriate for a C++ API.</p>
<p>
For instance,
</p>
<pre class="programlisting">./docextract_to_xml.py -s ~/checkout/gnome/gtk+/gtk/ > gtk_docs.xml
</pre>
<p>
</p>
<p>Because this automatic transformation is not always appropriate, you might
want to provide hand-written text for a particular method. You can do this
by copying the XML node for the function from your
<code class="filename">something_docs.xml</code> file to the
<code class="filename">something_docs_override.xml</code> file and changing the
contents.</p>
</div>
<div class="sect2">
<div class="titlepage"><div><div><h3 class="title">
<a name="wrapping-documentation-build-structure"></a>Documentation build structure</h3></div></div></div>
<p>If you copied the skeleton source tree in mm-common and substituted the
placeholder text, then you will already have suitable <code class="filename">Makefile.am</code>
and <code class="filename">Doxyfile.in</code> files. With the mm-common build setup, the list
of Doxygen input files is not defined in the Doxygen configuration file, but passed
along from <span class="command"><strong>make</strong></span> to the standard input of <span class="command"><strong>doxygen</strong></span>.
The input file list is defined by the <code class="varname">doc_input</code> variable in the
<code class="filename">Makefile.am</code> file.
</p>
</div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="sec-wrapping-problems.html"><img src="icons/prev.png" alt="Prev"></a> </td>
<td width="20%" align="center"><a accesskey="u" href="chapter-wrapping-c-libraries.html"><img src="icons/up.png" alt="Up"></a></td>
<td width="40%" align="right"> </td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Problems in the C API. </td>
<td width="20%" align="center"><a accesskey="h" href="index.html"><img src="icons/home.png" alt="Home"></a></td>
<td width="40%" align="right" valign="top"> </td>
</tr>
</table>
</div>
</body>
</html>
