Introduction

This developer and design manual is generated from the qucs sourcecode using Doxygen. Diagrams in the manual are produced by the dot utility–normally distributed as part of the graphviz package.

The standard source distribution does not generate this manual by default. Instead it provides a default doxygen configuration in the doxygen sub-directory. A local copy of this manual may be generated by using (from the qucs-doc top directory):

• cd doxygen; make doxygen

You may view your local copy by direcing a web browser to:

• file:///[qucs-doc directory]/doxygen/html/index.html

Hacking on this documentation

Eventually there will be a style guide for documenting, with an example of a one of the source files documented "by the book". Until then, feel free to start documenting or playing with doxygen configuration.

Doxygen Configuration

To edit the doxygen configuration, you can use (from the qucs-doc top directory):

• cd doxygen; doxywizard doxygen.cfg &

The default doxygen configuration only produces documentation for modules and data structures that have been explicitly tagged in the source code. More detailed documentation may be obtained by modifing the doxygen configuration file (.../doxygen/doxygen.cfg).

Options of particular interest include:

• INPUT which identifies the code to be scanned. The default configuration assumes that the qucs, qucs-core and qucs-doc top level directories are siblings.
• EXTRACT_ALL which will document all software components whether tagged or not.
• SOURCE_BROWSER which will embed implementation code in the documentation.

Enabling the latter two options will significantly increase the size of this manual, as well as the time it takes to generate it.

Doxygen reference documentation

The Doxygen web site (http://www.doxygen.org/) has a complete user manual. For the impatient, the most interesting sections are:

• How to write documentation blocks for files, functions, variables, etc.: http://www.doxygen.org/docblocks.html Be sure to include a file documentation block (@file or \file) at the top of your file. Without it your documentation will not appear in the html.
• List of the special commands you can use within your documentation blocks: http://www.doxygen.org/commands.html

Contacts

Web Site

News about Qucs as well as the latest version can always be found at the sourceforge project page http://qucs.sourceforge.net/

Email

If you have any suggestions concerning this documentation, do not hesitate to send suggestions to qucs-devel (see http://qucs.sourceforge.net/contact.html for details)

Author

Rich Johnson (rjohn.nosp@m.son@.nosp@m.dogst.nosp@m.ar-i.nosp@m.ntera.nosp@m.ctiv.nosp@m.e.com)