Synopsis User Manual

Table of Contents

1. Introduction

What is Synopsis?

How to use this manual

How to use Synopsis

How to format your comments

The parser

The linker

The formatter

Where to get more help

2. Tutorial

Running Synopsis

The easy way: copy a demo config + modify

The Makefile

The config.py file

The output explained

The hard way: create from scratch

The powerful way: new project file format

Project class

Action object

SourceAction Rules

Command Line Usage

The future way: use the GUI

3. The Parsers

C++ Parser

SXR and XREF

Options

Python Parser

Options

CORBA IDL Parser

4. The Linker

Unduplicator

Stripper

NameMapper

Comments

ssd

ss

java

qt

group

dummy

prev

javatags

summary

EmptyNS

AccessRestrictor

LanguageMapper

XRefCompiler

XRefCompiler options

Linker options

5. The HTML Formatter

Basics

Layouts

Pages

FramesIndex

ScopePages

ModuleListing

ModuleIndexer

FileListing

FileIndexer

FileDetails

FileSource

RawFilePages

DirBrowse

XRefPages

InheritanceGraph

InheritanceTree

NameIndex

Options

6. Other Formatters

HTML_Simple

DocBook

BoostBook

TexInfo

Dot

ASCII

DUMP

Dia

7. Customising Synopsis

Importing Objects and Import Specifications

New output format

New parser (new language)

New linker operation

New HTML Page