/**
@mainpage Planet Module API

Source repository: https://code.edge.launchpad.net/~m-baert .

You may download it directly from command line:
@verbatim
bzr branch lp:~m-baert/drupal-planet/6.x
@endverbatim

@section planet_info Module Definition
Here's how planet is defined in @c planet.info :

@li @c name   Planet
@li @c description Aggregates RSS feeds and faciliates their association with site users who belong to a given role.
@li @c package  Community - optional
@li @c version  6.x
@li @c core  6.x

@section menu_links Menus and Pages

Menu items and page callbacks are defined in the hook_menu()
    implementation, planet_menu.
 
This <a href="../../menu-links.svg">diagram</a> shows how requests are handled.

@dotfile menu-links.dot "Menus and Page Requests"

Each arrow is labeled with the permission required to access link.

The menu item colors reflect the item type:

@li <span class="menu_normal_item">MENU_NORMAL_ITEM</span>	(default) Normal menu items show up in the menu tree and can be moved/hidden by the administrator.
@li <span class="menu_local_task">MENU_LOCAL_TASK</span> 	Local tasks are rendered as tabs by default. For menu items that describe actions to be performed on their parent item.
@li <span class="menu_callback">MENU_CALLBACK</span> 	Callbacks simply register a path so that the correct function is fired when the URL is accessed. They are not shown in the menu.

@section funcalls Global calls graph

Here is a map of internal function calls.

It is quite large for now, and may not be easy to read as displayed here, 
but you may <a href="../../funcalls.svg">download the svg version here</a>.

Dashed lines show indirect invocations (
<span class="hook">hooks</span>, 
<span class="page">callbacks</span>, 
<span class="form">forms</span>,
other <span class="handler">handlers</span>
).

<span class="db_access">Database access</span> is also shown with access type indicators:
@li @b C : Create table rows
@li @b R : Read table rows
@li @b U : Update table rows
@li @b D : Delete table rows

 @dotfile funcalls.dot "Internal Function Calls"


@section planet_groups Function Groups

Each planet function may belong to one or more categories:

@li @ref base
@li @ref system
@li @ref page
@li @ref iforms
@li @ref planet_node
@li @ref ihooks
@li @ref planet_feed
@li @ref planet_item
@li @ref rss


*/
#@li @ref db_access
#@li @ref internal

// @DIFFINFO Group definitions for doxygen documentation
/**
 @defgroup ihooks All Implemented Hooks
 @{
 @defgroup base Basic Definitions for Planet Module
Main user interface.

 @defgroup system System Interaction
Various callbacks for reacting to drupal some system events.  

 @defgroup planet_node Planet Node Type support 
This group may not be easy to identify because our node type 
has the same name as the module: "planet".

@defgroup empty . 
@}
*/
# above "empty" group is a dirty trick to prevent doxygen from ejecting
# the last subgroup .

# Note:
Renaming "Modules" output section probably implies recompiling doxygen.
 http://www.nabble.com/Modules-book-title:-possible-to-rename---td15608879.html

/** 
 @defgroup page Page callbacks (Menu System)
Functions registered in planet_menu()
 
 @defgroup iforms Forms
User forms, invoked with drupal_get_form() .

 @defgroup isettings General Planet Settings

 @defgroup planet_feed Managing Planet feeds
 
 @defgroup planet_item Managing Planet feed items
 
 @defgroup rss RSS Feed Handling
 
 */
 #* @defgroup internal Internal Functions
 #* @defgroup db_access Functions accessing database (directly through Drupal API)