in the module index, which should ease the navigation to a particular part.
$Id$
+Sun Jan 29 14:31:35 CET 2006 dothebart
+* Doxygen groups. Sorted the files into groups. so now we have a nice structure
+ in the module index, which should ease the navigation to a particular part.
+
Sun Jan 29 00:12:25 EST 2006 ajc
* Clarified some of the doxygen comments
/**
*
* \defgroup WebcitAuth WebcitAuth; Handles authentication of users to a Citadel server.
- *
+ * \ingroup CitadelConfig
*/
/*@{*/
* $Id$
*//**
* \defgroup AjaxAutoCompletion ajax-powered autocompletion...
+ * \ingroup ClientPower
*/
/*@{*/
/**
*
* \defgroup CalendarAv Check attendee availability for scheduling a meeting.
- * \todo why doesn't anything of the documentation apear?
+ * \ingroup Calendaring
*/
/*@{*/
*/
/**
* \defgroup calav Functions which handle calendar objects and their processing/display.
- * \todo parts aren't parsed by doxygen
+ * \ingroup Calendaring
*/
/* @{ */
*/
/**
* \defgroup MiscCal Miscellaneous functions which handle calendar components.
+ * \ingroup Calendaring
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup CalHtmlHandles Handles the HTML display of calendar items.
+ * \ingroup Calendaring
*/
/*@{*/
#include "webcit.h"
* up HTTP requests with the sessions they belong to, using HTTP cookies to
* keep track of things. If the HTTP request doesn't belong to any currently
* active session, a new session is started.
+ * \ingroup WebcitHttpServer
*
*/
/*@{*/
* Utility functions which convert the HTTP cookie format we use to and
* from user/password/room strings.
*
+ * \ingroup WebcitHttpServer
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup https Provides HTTPS, when the OpenSSL library is available.
+ * \ingroup WebcitHttpServer
*/
/*@{*/
--- /dev/null
+/*
+ * ok, hacky, but gets us nice groups. so we define sub parts to join from other
+ * files here. NO CODE IN HERE! This is comment shouldn't appear in doxygen.
+ * we have:
+ * CitadelConfig; WebcitDisplayItems; WebcitHttpServer; WebcitHttpServerGDav;
+ * ClientPower; Calendaring; MenuInfrastructure; CitadelCommunitacion;
+ * WebcitHttpServerRSS; tools;
+ */
+
+
+/**
+ * \defgroup CitadelConfig Configuration Mechanisms
+ * \brief Functions about configuring citadel / webcit
+ */
+
+/*@{*/
+/*@}*/
+
+/**
+ * \defgroup tools Utility Functions
+ * \brief Functions that aren't related to webcit topics
+ */
+
+/*@{*/
+/*@}*/
+
+
+/**
+ * \defgroup WebcitDisplayItems Display some mime types through webcit
+ * \brief Functions that format mime types into HTML to the user
+ */
+
+/*@{*/
+/*@}*/
+
+/**
+ * \defgroup WebcitHttpServer the Webserver part
+ * \brief Functions that run the HTTP-Deamon
+ */
+
+/*@{*/
+/*@}*/
+
+/**
+ * \defgroup WebcitHttpServerGDav Groupdav Mechanisms
+ * \ingroup WebcitHttpServer
+ * \brief Functions that handle groupdav requests
+ */
+/*@{*/
+/*@}*/
+
+
+/**
+ * \defgroup WebcitHttpServerRSS RSS Mechanisms
+ * \ingroup WebcitHttpServer
+ * \brief Functions that handle RSS requests
+ */
+
+/*@{*/
+/*@}*/
+
+/**
+ * \defgroup ClientPower Client powered Functionality
+ * \brief Functions that spawn things on the webbrowser
+ */
+
+/*@{*/
+/*@}*/
+
+/**
+ * \defgroup Calendaring Calendaring background
+ * \brief Functions that make the Business-logic of the calendaring items
+ * \ingroup WebcitDisplayItems
+ */
+
+/*@{*/
+/*@}*/
+
+/**
+ * \defgroup MenuInfrastructure Things that guide you through the webcit parts
+ * \brief Functions that display menues, trees etc. to connect the parts of the
+ * ui to a whole thing
+ * \ingroup WebcitDisplayItems
+ */
+
+/*@{*/
+/*@}*/
+
+/**
+ * \defgroup CitadelCommunitacion Talk to the citadel server
+ * \brief Functions that talk to the citadel server and process reviewed entities
+ * \ingroup WebcitDisplayItems
+ */
+
+/*@{*/
+/*@}*/
+
+
+
*/
/**
* \defgroup EditCal Editing calendar events.
- *
+ * \ingroup Calendaring
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup AdminFloor Administrative screens for floor maintenance
- *
+ * \ingroup CitadelConfig
*/
/*@{*/
*/
/**
* \defgroup FormatDates Miscellaneous routines formating dates
+ * \ingroup Calendaring
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup LocaleHeaderParser Parse the browser http locale headers and set the NLS stuff.
+ * \ingroup WebcitHttpServer
*/
/*@{*/
/** we need _GNU_SOURCE for various functions arround the NLS-Stuff */
* $Id$
*
* Handles HTTP upload of graphics files into the system.
+ * \ingroup WebcitHttpServer
*/
#include "webcit.h"
*/
/**
* \defgroup GroupdavDel Handle GroupDAV DELETE requests.
- *
+ * \ingroup WebcitHttpServerGDav
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgraup GroupdavGet Handle GroupDAV GET requests.
+ * \ingroup WebcitHttpServerGDav
*
*/
/*@{*/
/**
- * \briefThe pathname is always going to be /groupdav/room_name/euid
+ * \brief The pathname is always going to be /groupdav/room_name/euid
* \param dav_pathname the pathname to print
*/
void groupdav_get(char *dav_pathname) {
*/
/**
* \defgroup GroupdavMain Entry point for GroupDAV functions
+ * \ingroup WebcitHttpServerGDav
*
*/
/*@{*/
* $Id$
*
* Handles DAV OPTIONS requests (experimental -- not required by GroupDAV)
+ * \ingroup WebcitHttpServerGDav
*
*/
* This makes it difficult to read, but we have discovered clients which
* crash when you try to pretty it up.
*
+ * \ingroup WebcitHttpServerGDav
*/
#include "webcit.h"
*/
/**
* \defgroup GroupdavPut Handles GroupDAV PUT requests.
+ * \ingroup WebcitHttpServerGDav
*
*/
/*@{*/
/**
* \defgroup HTML2HTML Output an HTML message, modifying it slightly to make sure it plays nice
* with the rest of our web framework.
- *
+ * \ingroup WebcitHttpServer
*/
/*@{*/
#include "webcit.h"
* \defgroup HTTPDateTime Function to generate HTTP-compliant textual time/date stamp
* (This module was lifted directly from the Citadel server source)
*
+ * \ingroup WebcitHttpServer
*/
/*@{*/
#include "webcit.h"
* Everything here will work on both a fully encapsulated VCALENDAR component
* or any type of subcomponent.
*
+ * \ingroup Calendaring
*/
/*@{*/
*/
/**
* \defgroup IconBar Displays and customizes the iconbar.
+ * \ingroup MenuInfrastructure
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup InetCfg Functions which handle Internet domain configuration etc.
- *
+ * \ingroup CitadelConfig
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup ListSubForms Web forms for handling mailing list subscribe/unsubscribe requests.
- *
+ * \ingroup WebcitDisplayItems
*/
/*@{*/
*/
/**
* \defgroup Hostlookup Examine a socket and determine the name/address of the originating host.
+ * \ingroup WebcitHttpServer
*/
/*@{*/
*/
/**
* \defgroup DispAdvancedMenu Displays the "advanced" (main) menu.
+ * \ingroup MenuInfrastructure
*
*/
/*@{*/
*/
/**
* \defgroup MsgDisp Functions which deal with the fetching and displaying of messages.
+ * \ingroup WebcitDisplayItems
*
*/
/*@{*/
*
* Copyright (c) 1998-2005 by Art Cancro
* This code is distributed under the terms of the GNU General Public License.
- *
+ * \ingroup WebcitHttpServer
*/
/*@{*/
#include "webcit.h"
/**
* \defgroup NetShareConf Functions which handle network and sharing configuration.
*
+ * \ingroup CitadelConfig
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup StickyNotes Functions which handle "sticky notes"
- *
+ * \ingroup WebcitDisplayItems
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup PageFunc Functions which implement the chat and paging facilities.
+ * \ingroup ClientPower
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup ManagePrefs Manage user preferences with a little help from the Citadel server.
+ * \ingroup CitadelConfig
*
*/
/*@{*/
*/
/**
* \defgroup RoomOps Lots of different room-related operations.
+ * \ingroup CitadelCommunitacion
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup RssRooms Generate some RSS for our rooms.
+ * \ingroup WebcitHttpServerRSS
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup ServFuncs Handles various types of data transfer operations with the Citadel service.
- *
+ * \ingroup CitadelCommunitacion
*/
/*@{*/
*/
/**
* \defgroup AdminConfig Administrative screen for site-wide configuration
- *
+ * \ingroup CitadelConfig
*/
/*@{*/
/**
* \defgroup SnprintfReplacement modified from Sten Gunterberg's BUGTRAQ post of 22 Jul 1997
* --nathan bryant <bryant@cs.usm.maine.edu>
- *
+ * \ingroup tools
*/
/*@{*/
/**
*/
/**
* \defgroup Subst Variable substitution type stuff
- *
+ * \ingroup CitadelConfig
*/
/*@{*/
*/
/**
* \defgroup SymaryFuncs Displays the "Summary Page"
+ * \ingroup WebcitDisplayItems
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup ShowSysMsgs Editing of various text files on the Citadel server.
+ * \ingroup WebcitDisplayItems
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup TabUtils Utility functions for creating tabbed dialogs
+ * \ingroup WebcitDisplayItems
*/
/*@{*/
#include "webcit.h"
*/
/**
* \defgroup TcpSockets TCP client socket module for WebCit
- *
+ * \ingroup CitadelCommunitacion
*/
/*@{*/
*/
/**
* \defgroup MiscRout Miscellaneous routines
+ * \ingroup tools
*/
/*@{*/
*/
/**
* \defgroup AdminTasks Administrative screen to add/change/delete user accounts
+ * \ingroup CitadelConfig
*
*/
/*@{*/
*/
/**
* \defgroup AccDisplay Display a list of all accounts on a Citadel system.
- *
+ * \ingroup CitadelConfig
*/
/*@{*/
/*
* $Id$
- */
-/**
- * \defgroup VCardMain vCard data type implementation for the Citadel system.
- *
* Copyright (C) 1999-2005 by Art Cancro
* This code is freely redistributable under the terms of the GNU General
* Public License. All other rights reserved.
*/
+/**
+ * \defgroup VCardMain vCard data type implementation for the Citadel system.
+ * \ingroup WebcitDisplayItems
+ */
/*@{*/
#include "webcit.h"
#include "webserver.h"
/*
* $Id$
+ * Copyright (C) 1999 by Art Cancro
+ * This code is freely redistributable under the terms of the GNU General
+ * Public License. All other rights reserved.
*/
/**
* \defgroup VcardHeader vCard implementation for Citadel
+ * \ingroup WebcitDisplayItems
*
- * Copyright (C) 1999 by Art Cancro
- * This code is freely redistributable under the terms of the GNU General
- * Public License. All other rights reserved.
*/
/*@{ */
*/
/**
* \defgroup vCardEdit Handles on-screen editing of vCard objects.
- * \ingroup WebFrontend
+ * \ingroup WebcitDisplayItems
*/
/*@{*/
#include "webcit.h"
* \defgroup MainServer This is the main transaction loop of the web service. It maintains a
* persistent session to the Citadel server, handling HTTP WebCit requests as
* they arrive and presenting a user interface.
- * \ingroup BackendWebServer
+ * \ingroup WebcitHttpServer
*/
/*@{*/
#include "webcit.h"
* \defgroup Webserver This contains a simple multithreaded TCP server manager. It sits around
* waiting on the specified port for incoming HTTP connections. When a
* connection is established, it calls context_loop() from context_loop.c.
- *
+ * \ingroup WebcitHttpServer
*/
/*@{*/
*/
/**
* \defgroup DislpayWho Display a list of all users currently logged on to the Citadel server.
+ * \ingroup WebcitDisplayItems
*/
/*@{*/
#include "webcit.h"
/**
*
* \defgroup Wiki Wiki; Functions pertaining to rooms with a wiki view
- *
+ * \ingroup WebcitDisplayItems
*/
/*@{*/