mainpage revision 29747dfe5e073a299b3681e01f5c55540f8bfed7
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews// -*- C++ -*-
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews// $Id: mainpage,v 1.2 2006/12/22 01:44:59 marka Exp $
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews// Doxygen text. Lines beginning with two slashes are comments; lines
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews// beginning with three slashes are Doxygen input.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \mainpage
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \section mainpage_overview Overview
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// This is the beginning of an internals manual for BIND9. It's
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// still very rough in many places.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li See the files in doc/doxygen for the source to this page and
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// the Doxygen configuration that generates the rest of the manual.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li See the tabs at the top of the screen to navigate through the
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// generated documentation.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li See <a href="http://www.doxygen.org/">the Doxygen web site</a>
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// for more information about Doxygen, including its manual.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \section mainpage_knownissues Known Issues
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// Known issues with our current use of Doxygen:
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li In a major departure from previous attempts to use Doxygen
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// with BIND9, this manual attempts to take the simplest approach
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// to every choice Doxygen gives us. We don't generate fancy
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// extra Doxygen tags files from the RFC database. We don't
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// attempt to use Doxygen as a wrapper framework for other
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// documentation (eg, ISC Tech Notes, the ARM, ...). We don't
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// try to generate the list of files to document on the fly.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// Instead, we attempt to use Doxygen's native facilities
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// wherever possible, on the assumption that we'll add new
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// features later as we need them but should start as simply as
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li Our use of \\file is wrong in many places. We probably should
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// be marking header files with the names by which we include
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// them (eg, "dns/resolver.h"). Doxygen reports filename
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// conflicts in a few cases where it can't work out which of
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// several files to use.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li At the moment we're instructing Doxygen to document all
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// functions, whether they have proper comment markup or not.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// This is a good way to see what's been marked up, but might not
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// be the right approach in the long run.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li See doc/doxygen/doxygen-input-filter.in for local abbreviations.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li We're probably over-using the \\brief markup tag.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li We may in fact be confusing Doxygen to the point where it's
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// not finding markup comments that it should. Needs
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// investigation.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li At the moment I have all the cool "dot" stuff turned off,
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// both because it's a distraction and because it slows down
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// doxygen runs. Maybe after I get a faster desk machine. :)
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li At the moment we're producing a single "BIND9 Internals"
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// manual. One of our previous complications was an attempt to
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// produce separate manuals for each library, then cross-link
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// them. We might still need separate library manuals, but, if
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// so, it might be easier to have the BIND9 Internals manual be a
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// superset of the library manuals (ie, reuse the same source to
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// produce differently scoped manuals). Would certainly be
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// simpler than the cross-linking mess, but partly it's a
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// question of how we want to present the material.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li Doxygen is slanted towards C++. It can be tuned towards plain
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// old C, but the C++ bias still shows up in places, eg, the lack
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// of top-level menu support for functions (in C++, the basic
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// unit of programming is the class, which Doxygen does support
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// directly). This is a bit annoying, but not all that
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// critical.
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// \li If we ever get really ambitious, we might try processing
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// Doxygen's XML output, which is basicly a dump of what Doxygen
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// was able to scrape from the sources. This would be a major
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// project, just something to think about if there's something we
29747dfe5e073a299b3681e01f5c55540f8bfed7Mark Andrews/// really don't like about the output Doxygen generates. Punt