doc/Programming-Guide/Groups.dox

   1 /**
   2  \defgroup POD              POD Classes
   3  *
   4  \par
   5  *     Classes which encapsulate POD (plain old data) in such a way
   6  *     that they can be used as POD themselves and passed around Squid.
   7  *     These objects should have a formal API for safe handling of their
   8  *     content, but it MUST NOT depend on any externality than itself
   9  *     or the standard C++ libraries.
  10  */
  11
  12 /**
  13  \defgroup Components           Squid Components
  14  */
  15
  16 /**
  17  \defgroup ServerProtocol       Server-Side Protocols
  18  \ingroup Components
  19  \par
  20  *   These routines are responsible for forwarding cache misses
  21  *   to other servers, depending on the protocol.  Cache misses
  22  *   may be forwarded to either origin servers, or other proxy
  23  *   caches.
  24  *   All requests to other proxies are sent as HTTP requests.
  25  *   All requests to origin-server are sent in that servers protocol.
  26  *
  27  \par
  28  *   Wais and Gopher don't receive much
  29  *   attention because they comprise a relatively insignificant
  30  *   portion of Internet traffic.
  31  */
  32
  33 /**
  34  \defgroup libsquid         Squid Library
  35  *
  36  \par
  37  *     These objects are provided publicly through lidsquid.la
  38  */
  39
  40 /**
  41  \defgroup Tests            Unit Testing
  42  *
  43  \par
  44  *      Any good application has a set of tests to ensure it stays
  45  *      in a good condition. Squid tends to use cppunit tests.
  46  \par
  47  *      It is preferrable to automated tests for units of functionality. There
  48  *      is a boilerplate for tests in "src/tests/testBoilerplate.[cc|h]". New
  49  *      tests need to be added to src/Makefile.am to build and run them during
  50  *      "make check". To add a new test script, just copy the references to
  51  *      testBoilerplate in Makefile.am adjusting the name, and likewise copy the
  52  *      source files. If you are testing an already tested area you may be able
  53  *      to just add new test cases to an existing script. I.e. to test the store
  54  *      some more just edit tests/testStore.h and add a new unit test method
  55  *      name.
  56  */
  57
  58 /**
  59  \defgroup Callbacks         Event Callback Functions
  60  *
  61  \par
  62  *      Squid uses events to process asynchronous actions.
  63  *      These mehods are registered as callbacks to receive notice whenever a
  64  *      specific event occurs.
  65  */
  66
  67 /**
  68  \defgroup Timeouts             Timeouts
  69  \todo DOCS: document Timeouts.
  70  */
  71
  72 /**
  73  \defgroup ServerProtocolHTTP HTTP
  74  \ingroup ServerProtocol
  75  \todo Write Documentation about HTTP
  76  */
  77
  78 /**
  79  \defgroup ServerProtocolFTPAPI Server-Side FTP API
  80  \ingroup ServerProtocol
  81  */
  82
  83 /**
  84  \defgroup ServerProtocolWAIS WAIS
  85  \ingroup ServerProtocol
  86  \todo Write Documentation about Wais
  87  */
  88
  89 /**
  90  \defgroup ServerProtocolPassthru Passthru
  91  \ingroup ServerProtocol
  92  \todo Write Documentation about Passthru
  93  */