<?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 Tutorial</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="next" href="intro.html" title="Chapter 1. Introduction" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Synopsis Tutorial</th></tr><tr><td width="20%" align="left"> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="intro.html">Next</a></td></tr></table></div><div class="book" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="id430852"></a>Synopsis Tutorial</h1></div><div><div class="author"><h3 class="author"><span class="firstname">Stefan</span> <span class="surname">Seefeld</span></h3></div></div><div><p class="releaseinfo">Version 0.12</p></div></div><hr /></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="chapter"><a href="intro.html">1. Introduction</a></span></dt><dd><dl><dt><span class="section"><a href="inspecting.html">Inspecting Code</a></span></dt><dt><span class="section"><a href="ir.html">Internal Representations</a></span></dt><dt><span class="section"><a href="documenting.html">Documenting Source-Code</a></span></dt><dt><span class="section"><a href="processing.html">The Synopsis Processing Pipeline</a></span></dt></dl></dd><dt><span class="chapter"><a href="using.html">2. Using the synopsis tool</a></span></dt><dd><dl><dt><span class="section"><a href="options.html">Option Handling</a></span></dt><dt><span class="section"><a href="parsing.html">Parsing Source-code</a></span></dt><dt><span class="section"><a href="compiler-emulation.html">Emulating A Compiler</a></span></dt><dt><span class="section"><a href="comments.html">Using Comments For Documentation</a></span></dt></dl></dd><dt><span class="chapter"><a href="scripting.html">3. Scripting And Extending Synopsis</a></span></dt><dd><dl><dt><span class="section"><a href="asg.html">The ASG</a></span></dt><dt><span class="section"><a href="processor.html">The Processor class</a></span></dt><dt><span class="section"><a href="pipeline.html">Composing A Pipeline</a></span></dt><dt><span class="section"><a href="script.html">Writing your own synopsis script</a></span></dt><dd><dl><dt><span class="section"><a href="script.html#importing">Importing all desired processors</a></span></dt><dt><span class="section"><a href="script.html#composing">Composing new processors</a></span></dt><dt><span class="section"><a href="script.html#extending">Defining New Processors</a></span></dt><dt><span class="section"><a href="script.html#process">Exposing The Commands</a></span></dt></dl></dd></dl></dd><dt><span class="chapter"><a href="processors.html">4. Processor Design</a></span></dt><dd><dl><dt><span class="section"><a href="python-parser.html">The Python Parser</a></span></dt><dt><span class="section"><a href="idl-parser.html">The IDL Parser</a></span></dt><dt><span class="section"><a href="cpp-parser.html">The Cpp Parser</a></span></dt><dt><span class="section"><a href="cc-parser.html">The C Parser</a></span></dt><dt><span class="section"><a href="cxx-parser.html">The Cxx Parser</a></span></dt><dt><span class="section"><a href="linker.html">The Linker</a></span></dt><dt><span class="section"><a href="comment-processors.html">Comment Processors</a></span></dt><dd><dl><dt><span class="section"><a href="comment-processors.html#comment-filters">Comment Filters</a></span></dt><dt><span class="section"><a href="comment-processors.html#comment-translators">Comment Translators</a></span></dt><dt><span class="section"><a href="comment-processors.html#comment-transformers">Transformers</a></span></dt></dl></dd><dt><span class="section"><a href="dump-formatter.html">The Dump Formatter</a></span></dt><dt><span class="section"><a href="docbook-formatter.html">The DocBook Formatter</a></span></dt><dt><span class="section"><a href="dot-formatter.html">The Dot Formatter</a></span></dt><dt><span class="section"><a href="html-formatter.html">The HTML Formatter</a></span></dt><dt><span class="section"><a href="sxr-formatter.html">The SXR Formatter</a></span></dt></dl></dd><dt><span class="appendix"><a href="executable.html">A. Description of program options for the synopsis executable</a></span></dt><dt><span class="appendix"><a href="processor-listing.html">B. Listing of some Processors and their parameters</a></span></dt><dd><dl><dt><span class="section"><a href="Python-Parser-ref.html">Synopsis.Parsers.Python.Parser</a></span></dt><dt><span class="section"><a href="IDL-Parser-ref.html">Synopsis.Parsers.IDL.Parser</a></span></dt><dt><span class="section"><a href="Cpp-Parser-ref.html">Synopsis.Parsers.Cpp.Parser</a></span></dt><dt><span class="section"><a href="C-Parser-ref.html">Synopsis.Parsers.C.Parser</a></span></dt><dt><span class="section"><a href="Cxx-Parser-ref.html">Synopsis.Parsers.Cxx.Parser</a></span></dt><dt><span class="section"><a href="Processors-Linker-ref.html">Synopsis.Processors.Linker</a></span></dt><dt><span class="section"><a href="Processors-MacroFilter-ref.html">Synopsis.Processors.MacroFilter</a></span></dt><dt><span class="section"><a href="Comments-Filter-ref.html">Synopsis.Processors.Comments.Filter</a></span></dt><dt><span class="section"><a href="Comments-Translator-ref.html">Synopsis.Processors.Comments.Translator</a></span></dt><dt><span class="section"><a href="Dot-Formatter-ref.html">Synopsis.Formatters.Dot.Formatter</a></span></dt><dt><span class="section"><a href="Dump-Formatter-ref.html">Synopsis.Formatters.Dump.Formatter</a></span></dt><dt><span class="section"><a href="DocBook-Formatter-ref.html">Synopsis.Formatters.DocBook.Formatter</a></span></dt><dt><span class="section"><a href="Texinfo-Formatter-ref.html">Synopsis.Formatters.Texinfo.Formatter</a></span></dt><dt><span class="section"><a href="HTML-Formatter-ref.html">Synopsis.Formatters.HTML.Formatter</a></span></dt><dt><span class="section"><a href="SXR-Formatter-ref.html">Synopsis.Formatters.SXR.Formatter</a></span></dt></dl></dd><dt><span class="appendix"><a href="markup.html">C. Supported Documentation Markup</a></span></dt><dd><dl><dt><span class="section"><a href="javadoc.html">Javadoc</a></span></dt><dt><span class="section"><a href="rest.html">ReStructured Text</a></span></dt></dl></dd></dl></div><div class="list-of-examples"><p><b>List of Examples</b></p><dl><dt>1.1. <a href="documenting.html#id490951">Typical C++ code documentation</a></dt><dt>1.2. <a href="documenting.html#id490998">Python code documentation</a></dt><dt>C.1. <a href="javadoc.html#id493667">C++ code snippet using Javadoc-style comments.</a></dt><dt>C.2. <a href="rest.html#id493718">C++ code snippet using ReST-style comments.</a></dt></dl></div></div><div class="navfooter"><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="intro.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"> </td><td width="40%" align="right" valign="top"> Chapter 1. Introduction</td></tr></table></div></body></html>
