Synopsis Examples

# Synopsis - Examples

## Diagrams

Here are some examples of class- and other diagrams synopsis can generate, with explanation

## HTML

### Default Settings

This is an API reference generated with the default HTML formatter settings. The sources include documentation in different markup, such as RestructuredText, or Javadoc.

### No Frames

This is the same HTML formatter, but without frames.

### Source Cross Reference

This is again the HTML formatter, but customized a bit to also include source cross-referencing.

## SXR

The Synopsis Cross-Reference tool allows to search for (type, variable, function, and file) names by means of a CGI script. Please see the build instructions for the Paths/sxr example for the required steps to start the sxr-server tool. The Synopsis website uses this to navigate its own source code here.

## DocBook

### Default Settings

Paths.xml

#### HTML

This is a C++ API reference generated with the default DocBook formatter settings, using the XHTML stylesheets from the xsl-docbook package. The sources include documentation in different markup, such as RestructuredText, or Javadoc.

#### PDF

This is the same, but formatted as pdf using the FO stylesheets.

### Alternative Settings

#### HTML

This is a C API reference generated with the default DocBook formatter settings, using the XHTML stylesheets from the xsl-docbook package.

## Hybrid IDL / C++ code

Synopsis is able to cross-reference two distinct Reference manuals, using TOCs. Moreover, it is possible to map symbols across lanugage-boundaries. This example shows an IDL interface cross-referenced with a C++ implementation.