cygnal/mainpage.doxygen.txt

   1 /**
   2
   3 \mainpage GNU Cygnal
   4
   5 \section s_Introduction Introduction
   6
   7         Documentation for the source code of GNU Cygnal.
   8
   9 \section s_Code_Organization Code Organization
  10
  11         The code is organized into a set of modules:
  12         - \ref ACT.
  13                 Asynchronous Computation Task.
  14                 The multitasking foundation of the system.
  15         - \ref IO.
  16                 Input/Output.
  17                 ACT-enabled I/O infrastructure.
  18                 Provides scattered buffering and the conversion of asynchronous block I/O into an asynchronous stream abstraction.
  19         - Net.
  20                 Network I/O.
  21                 ACT-enabled network primitives.
  22         - HTTP.
  23                 HTTP syntax and protocol behavior.
  24
  25 \section s_Running_Doxygen Running Doxygen [EH as of 2007-07-05]
  26
  27         Doxygen doesn't deal so well with code that makes heavy use of templates.
  28         Here's a <a href="http://bugzilla.gnome.org/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=template&product=doxygen&long_desc_type=substring&long_desc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&emailassigned_to1=1&emailtype1=substring&email1=&emailassigned_to2=1&emailreporter2=1&emailqa_contact2=1&emailcc2=1&emailtype2=substring&email2=&bugidtype=include&bug_id=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Bug+Number&field0-0-0=noop&type0-0-0=noop&value0-0-0=">search for doxygen template defects</a>.
  29         While it would be a good thing for doxygen to run without errors, that's not happening now.
  30         The two most common defects seem to be these:
  31                 - No recognition of explicit template instantiation: http://bugzilla.gnome.org/show_bug.cgi?id=331519.
  32                 - Conflation of members in template specifications: http://bugzilla.gnome.org/show_bug.cgi?id=406027.
  33         There are a couple of other errors doxygen spits out.
  34         I haven't located them in the doxygen issue tracker.
  35
  36  */