<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>API Extractor — 3.7. Manipulating Documentation</title>
<link rel="stylesheet" href="_static/pysidedocs.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '#',
VERSION: '0.10.0',
COLLAPSE_MODINDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<!--[if lt IE 7]>
<style media="screen" type="text/css">
#container {
height:100%;
}
</style>
<![endif]-->
<link rel="top" title="API Extractor v0.10.0 documentation" href="index.html" />
<link rel="up" title="3. The API Extractor Type System" href="typesystem.html" />
<link rel="prev" title="3.6. Using Code Templates" href="typesystem_templates.html" />
</head>
<body id="typesystem_documentation">
<div id="container">
<div id="header">
<div id="header_container">
<div id="logo"><a href="http://www.pyside.org"><img alt="PySide" src="_static/pysidelogo.png" width="199" height="102" /></a></div>
<ul id="relbar">
<li class="right">
<a href="typesystem_templates.html" title="3.6. Using Code Templates"
accesskey="P">previous</a></li>
<li><a href="contents.html">API Extractor v0.10.0 documentation</a> »</li>
<li><a href="typesystem.html" accesskey="U">3. The API Extractor Type System</a> »</li>
</ul>
</div>
</div>
<div id="body" >
<div id="sidebar">
<h3><a href="contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">3.7. Manipulating Documentation</a><ul>
<li><a class="reference internal" href="#inject-documentation">3.7.1. inject-documentation</a></li>
<li><a class="reference internal" href="#modify-documentation">3.7.2. modify-documentation</a></li>
</ul>
</li>
</ul>
<h3>Previous topic</h3>
<p class="topless"><a href="typesystem_templates.html"
title="previous chapter">3.6. Using Code Templates</a></p>
<div id="search_box">
<h3>Quick search</h3>
<form action="search.html" method="get">
<input type="text" name="q" id="q" />
<input type="submit" value="Go" id="search_button" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="section" id="manipulating-documentation">
<h1>3.7. Manipulating Documentation</h1>
<div class="section" id="inject-documentation">
<h2>3.7.1. inject-documentation</h2>
<blockquote>
<div><p>The inject-documentation node inserts the documentation into the generated
documentation. This node is a child of the object-type, value-type and
modify-function nodes.</p>
<div class="highlight-xml"><div class="highlight"><pre><span class="nt"><value-type></span>
<span class="nt"><inject-documentation</span> <span class="na">mode=</span><span class="s">"append | prepend | replace"</span> <span class="na">format=</span><span class="s">"native | target"</span> <span class="nt">></span>
// the documentation
<span class="nt"></inject-code></span>
<span class="nt"></value-type></span>
</pre></div>
</div>
<p>The <strong>mode</strong> attribute default value is <em>replace</em>.</p>
<p>The <strong>format</strong> attribute specifies when the documentation injection will
occur and it accepts the following values:</p>
<blockquote>
<div><ul class="simple">
<li>native: Before XML<->Backend transformation occur, so the injected code <em>must</em> be a valid XML.</li>
<li>target: After XML<->Backend transformation occur, so the injected code <em>must</em> be a valid backend format.</li>
</ul>
</div></blockquote>
<p>At the moment the only supported backend is Sphinx.</p>
</div></blockquote>
</div>
<div class="section" id="modify-documentation">
<h2>3.7.2. modify-documentation</h2>
<blockquote>
<div><p>The modify-documentation node allows you to change the auto-generated
documentation. API Extractor transforms XML’s from qdoc3 (the Qt documentation
tool) into .rst files to be processed later using Sphinx. So you can modify
the XML before the transformation occur.</p>
<div class="highlight-xml"><div class="highlight"><pre><span class="nt"><modify-documentation</span> <span class="na">xpath=</span><span class="s">"..."</span><span class="nt">></span>
<span class="c"><!-- new documentation --></span>
<span class="nt"></modify-documentation></span>
</pre></div>
</div>
<p>The <strong>xpath</strong> attribute is the XPath to the node that you want to modify.</p>
</div></blockquote>
</div>
</div>
</div> <!-- container -->
<div id="footer">
<a href="http://www.indt.org.br"><img src="_static/logo_indt.jpg" alt="Indt" border="0" /></a>
<a href="http://www.openbossa.org"><img src="_static/logo_openbossa.png" alt="Openbossa" border="0" /></a>
<a href="http://qt.nokia.com/"><img src="_static/logo_qt.png" alt="Qt" border="0" /></a>
<a href="http://www.python.org"><img src="_static/logo_python.jpg" alt="Python" border="0" /></a>
</div>
</div>
</body>
</html>
