|
Packit |
a4aae4 |
// -*- C++ -*-
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
// $Id: main_page.doxygen 21281 2009-08-18 06:38:17Z tomss $
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
// Documentation for the main page of the doxygen-generated reference manual
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
/** \mainpage
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
\section intro Introduction
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
This reference documentation corresponds to version @PACKAGE_VERSION@ of libdap, a C++
|
|
Packit |
a4aae4 |
implementation of DAP2, with some extensions. The libdap library
|
|
Packit |
a4aae4 |
includes classes and functions which implement DAP 2.0 as well as utilities
|
|
Packit |
a4aae4 |
which simpify building clients and servers for DAP 2.0 and DAP4.0.
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
\section conventions Doxygen Conventions
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
This section lists some conventions used by the Doxygen comments
|
|
Packit |
a4aae4 |
which are used to generate this Reference Guide. Follow these conventions
|
|
Packit |
a4aae4 |
when adding to or modifying the reference documentation.
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
\subsection general General
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
When using the name of a parameter, use italics (the \c e
|
|
Packit |
a4aae4 |
command or \c em tag).
|
|
Packit |
a4aae4 |
Use the \c c command or \c code tag when talking about literal text.
|
|
Packit |
a4aae4 |
When talking about functions or methods, using func()
|
|
Packit |
a4aae4 |
or func(arg0, ..., agrN) will get Doxygen to insert a link to
|
|
Packit |
a4aae4 |
its documentation.
|
|
Packit |
a4aae4 |
Typos: If you're using emacs, the command \c ispell-comments-and-strings
|
|
Packit |
a4aae4 |
may help in removing typos in the comments (and strings ...)
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
\subsection classes Classes
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
Classes should be documented in the header (\c .h) file where they are
|
|
Packit |
a4aae4 |
defined.
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
Commands that should be used for the documentation of classes:
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
authorUse this to attribute authorship. Include this for
|
|
Packit |
a4aae4 |
all the classes except internal ones which are not visible to users of the
|
|
Packit |
a4aae4 |
library.
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
\subsection methods Methods and Functions
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
Methods should be documented in the implementation (\c .cc) files where
|
|
Packit |
a4aae4 |
they are defined. You can put the \c brief documentation in the header file,
|
|
Packit |
a4aae4 |
but that may be more confusing than keeping all the method documentation in
|
|
Packit |
a4aae4 |
one place.
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
Functions should be documented in their implementation files.
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
Commands that should be used for the documentation of public methods and
|
|
Packit |
a4aae4 |
non-static functions:
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
param Include for all parameters. Doxygen complains if an
|
|
Packit |
a4aae4 |
overloaded method changes a parameter name, so scan the warnings and try to
|
|
Packit |
a4aae4 |
keep the names in sync..
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
return Include for all methods that return something unless the
|
|
Packit |
a4aae4 |
method is so simple its full description starts off with "Returns..."
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
brief Include for all methods. In doxy.conf I have turned off
|
|
Packit |
a4aae4 |
the option that generates the \c brief entry from the first sentence of the
|
|
Packit |
a4aae4 |
detailed doc and the option that includes the \c brief documentation in the
|
|
Packit |
a4aae4 |
detailed documentation. So, the \c brief doc will appear only with the
|
|
Packit |
a4aae4 |
summary information and not with the detailed documentation for the
|
|
Packit |
a4aae4 |
method.
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
exception Document the exceptions using the \c exception
|
|
Packit |
a4aae4 |
command.
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
|
|
Packit |
a4aae4 |
*/
|