Bug#109707: ITP: synopsis -- Synopsis is a general source code documentation tool.
Version: N/A; reported 2001-08-22
I intend to package synopsis.
I have contacted upstream and he has no objections.
Synopsis is a general source code documentation tool. By means of a
modular structure it adapts to different styles of embedded
documentation, different programming languages and various output
formats. It scales well with the size of the project by allowing
processing to be controlled by Makefiles.
The original goal of this project was to be able to generate a
reference manual for a project we are working on which uses different
programming lanugages: the protocols are defined with IDL and the
implementation is written in C++. There are no tools to support
document generation with explicit cross references between both parts.
When thinking about how to design a tool which is able to do that, it
was quickly concluded that other parts could be 'outsourced' into
separate modules as well, such as the formatting of the generated
syntax tree. These are a couple of ideas which hopefully make it a tool
which is useful in a wide range of projects.
author: Stefan Seefeld <email@example.com>
-- System Information
Debian Release: testing/unstable
Kernel: Linux tolkien 2.2.19-tolkien #1 Thu Apr 12 14:26:43 PDT 2001 i686
Locale: LANG=en_US, LC_CTYPE=en_US