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
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:
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.
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 (
Options of particular interest include:
INPUTwhich identifies the code to be scanned. The default configuration assumes that the
qucs-doctop level directories are siblings.
EXTRACT_ALLwhich will document all software components whether tagged or not.
SOURCE_BROWSERwhich 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.
The Doxygen web site (
http://www.doxygen.org/) has a complete user manual. For the impatient, the most interesting sections are:
http://www.doxygen.org/docblocks.htmlBe 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.
News about Qucs as well as the latest version can always be found at the sourceforge project page http://qucs.sourceforge.net/
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)