<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!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>Synopsis.Formatters.DocBook.Formatter</title><link rel="stylesheet" href="synopsis.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /><link rel="start" href="index.html" title="Synopsis Tutorial" /><link rel="up" href="processor-listing.html" title="Appendix B. Listing of some Processors and their parameters" /><link rel="prev" href="Dump-Formatter-ref.html" title="Synopsis.Formatters.Dump.Formatter" /><link rel="next" href="Texinfo-Formatter-ref.html" title="Synopsis.Formatters.Texinfo.Formatter" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Synopsis.Formatters.DocBook.Formatter</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="Dump-Formatter-ref.html">Prev</a> </td><th width="60%" align="center">Appendix B. Listing of some Processors and their parameters</th><td width="20%" align="right"> <a accesskey="n" href="Texinfo-Formatter-ref.html">Next</a></td></tr></table></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="DocBook-Formatter-ref"></a>Synopsis.Formatters.DocBook.Formatter</h2></div></div></div><div class="segmentedlist"><table border="0"><thead><tr class="segtitle"><th>Name</th><th>Default value</th><th>Description</th></tr></thead><tbody><tr class="seglistitem"><td class="seg">profile</td><td class="seg">False</td><td class="seg">output profile data</td></tr><tr class="seglistitem"><td class="seg">secondary_index_terms</td><td class="seg">True</td><td class="seg">add fully-qualified names to index</td></tr><tr class="seglistitem"><td class="seg">inline_inherited_members</td><td class="seg">False</td><td class="seg">show inherited members</td></tr><tr class="seglistitem"><td class="seg">verbose</td><td class="seg">False</td><td class="seg">operate verbosely</td></tr><tr class="seglistitem"><td class="seg">title</td><td class="seg">None</td><td class="seg">title to be used in top-level section</td></tr><tr class="seglistitem"><td class="seg">nested_modules</td><td class="seg">False</td><td class="seg">Map the module tree to a tree of docbook sections.</td></tr><tr class="seglistitem"><td class="seg">hide_undocumented</td><td class="seg">False</td><td class="seg">hide declarations without a doc-string</td></tr><tr class="seglistitem"><td class="seg">generate_summary</td><td class="seg">False</td><td class="seg">generate scope summaries</td></tr><tr class="seglistitem"><td class="seg">with_inheritance_graphs</td><td class="seg">True</td><td class="seg">whether inheritance graphs should be generated</td></tr><tr class="seglistitem"><td class="seg">input</td><td class="seg">[]</td><td class="seg">input files to process</td></tr><tr class="seglistitem"><td class="seg">debug</td><td class="seg">False</td><td class="seg">generate debug traces</td></tr><tr class="seglistitem"><td class="seg">output</td><td class="seg"></td><td class="seg">output file to save the ir to</td></tr><tr class="seglistitem"><td class="seg">markup_formatters</td><td class="seg">{rst: Synopsis.Formatters.DocBook.Markup.RST, reStructuredText: Synopsis.Formatters.DocBook.Markup.RST, javadoc: Synopsis.Formatters.DocBook.Markup.Javadoc}</td><td class="seg">Markup-specific formatters.</td></tr><tr class="seglistitem"><td class="seg">graph_color</td><td class="seg">#ffcc99</td><td class="seg">base color for inheritance graphs</td></tr></tbody></table></div></div><div class="navfooter"><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="Dump-Formatter-ref.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="processor-listing.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="Texinfo-Formatter-ref.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Synopsis.Formatters.Dump.Formatter </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Synopsis.Formatters.Texinfo.Formatter</td></tr></table></div></body></html>
