diff options
author | Dries Buytaert <dries@buytaert.net> | 2004-08-21 06:42:38 +0000 |
---|---|---|
committer | Dries Buytaert <dries@buytaert.net> | 2004-08-21 06:42:38 +0000 |
commit | 94e30bf7761f5857945df906ae5ba7da5c2fc9b5 (patch) | |
tree | b7a3c1801f3ba7ef2be6a0a3c0bde0781542a234 /modules | |
parent | 6696028a759b50e5551f471e4d71443744201da4 (diff) | |
download | brdo-94e30bf7761f5857945df906ae5ba7da5c2fc9b5.tar.gz brdo-94e30bf7761f5857945df906ae5ba7da5c2fc9b5.tar.bz2 |
- Patch by JonBob: for consistency and readability, add brief descriptions of each source file inside the @file comment block at the head of the file. This helps with Doxygen indexing, and also allows neophytes to see what a file does immediately on opening the source, regardless of the organization of the hooks.
Diffstat (limited to 'modules')
60 files changed, 276 insertions, 10 deletions
diff --git a/modules/admin.module b/modules/admin.module index 3bb035246..d528c2d49 100644 --- a/modules/admin.module +++ b/modules/admin.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Handles the administration pages. + */ + +/** * Implementation of hook_help(). */ function admin_help($section) { diff --git a/modules/aggregator.module b/modules/aggregator.module index 77e0cf6f2..65cfbf52a 100644 --- a/modules/aggregator.module +++ b/modules/aggregator.module @@ -2,6 +2,11 @@ /* $Id$ */ /** + * @file + * Used to aggregate syndicated content (RSS and RDF). + */ + +/** * Implementation of hook_help(). */ function aggregator_help($section) { diff --git a/modules/aggregator/aggregator.module b/modules/aggregator/aggregator.module index 77e0cf6f2..65cfbf52a 100644 --- a/modules/aggregator/aggregator.module +++ b/modules/aggregator/aggregator.module @@ -2,6 +2,11 @@ /* $Id$ */ /** + * @file + * Used to aggregate syndicated content (RSS and RDF). + */ + +/** * Implementation of hook_help(). */ function aggregator_help($section) { diff --git a/modules/archive.module b/modules/archive.module index 359d9e189..57bea3419 100644 --- a/modules/archive.module +++ b/modules/archive.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Displays a calendar to navigate old content. + */ + +/** * Implementation of hook_help(). */ function archive_help($section) { diff --git a/modules/archive/archive.module b/modules/archive/archive.module index 359d9e189..57bea3419 100644 --- a/modules/archive/archive.module +++ b/modules/archive/archive.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Displays a calendar to navigate old content. + */ + +/** * Implementation of hook_help(). */ function archive_help($section) { diff --git a/modules/block.module b/modules/block.module index 7a755f7e7..5ecf0f9ae 100644 --- a/modules/block.module +++ b/modules/block.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Controls the boxes that are displayed around the main content. + */ + +/** * Implementation of hook_help(). */ function block_help($section) { diff --git a/modules/block/block.module b/modules/block/block.module index 7a755f7e7..5ecf0f9ae 100644 --- a/modules/block/block.module +++ b/modules/block/block.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Controls the boxes that are displayed around the main content. + */ + +/** * Implementation of hook_help(). */ function block_help($section) { diff --git a/modules/blog.module b/modules/blog.module index cbbf70edb..a40bb64b3 100644 --- a/modules/blog.module +++ b/modules/blog.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables keeping an easily and regularly updated web page or a blog. + */ + +/** * Implementation of hook_settings(). */ function blog_settings() { diff --git a/modules/blog/blog.module b/modules/blog/blog.module index cbbf70edb..a40bb64b3 100644 --- a/modules/blog/blog.module +++ b/modules/blog/blog.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables keeping an easily and regularly updated web page or a blog. + */ + +/** * Implementation of hook_settings(). */ function blog_settings() { diff --git a/modules/blogapi.module b/modules/blogapi.module index af20f89e2..ef902edb8 100644 --- a/modules/blogapi.module +++ b/modules/blogapi.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enable users to post using applications that support XML-RPC blog APIs. + */ + +/** * Implementation of hook_help(). */ function blogapi_help($section) { @@ -9,7 +14,7 @@ function blogapi_help($section) { case 'admin/help#blogapi': return t('This module adds support for several XML-RPC based blogging APIs. Specifically, it currently implements the %bloggerAPI, %metaweblogAPI, and most of the %moveabletype extensions. This allows users to contribute to drupal using external GUI applications, which can often offer richer functionality that online forms based editing', array('%bloggerAPI' => '<a href="http://www.blogger.com/developers/api/1_docs/">Blogger API</a>', '%metaweblogAPI' => '<a href="http://www.xmlrpc.com/metaWeblogApi">MetaWeblog API</a>', '%moveabletype' => '<a href="http://www.movabletype.org/docs/mtmanual_programmatic.html">Moveable Type API</a>')); case 'admin/modules#description': - return t('Enable users to post using applications that support XML-RPC blog APIs'); + return t('Enable users to post using applications that support XML-RPC blog APIs.'); } } diff --git a/modules/blogapi/blogapi.module b/modules/blogapi/blogapi.module index af20f89e2..ef902edb8 100644 --- a/modules/blogapi/blogapi.module +++ b/modules/blogapi/blogapi.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enable users to post using applications that support XML-RPC blog APIs. + */ + +/** * Implementation of hook_help(). */ function blogapi_help($section) { @@ -9,7 +14,7 @@ function blogapi_help($section) { case 'admin/help#blogapi': return t('This module adds support for several XML-RPC based blogging APIs. Specifically, it currently implements the %bloggerAPI, %metaweblogAPI, and most of the %moveabletype extensions. This allows users to contribute to drupal using external GUI applications, which can often offer richer functionality that online forms based editing', array('%bloggerAPI' => '<a href="http://www.blogger.com/developers/api/1_docs/">Blogger API</a>', '%metaweblogAPI' => '<a href="http://www.xmlrpc.com/metaWeblogApi">MetaWeblog API</a>', '%moveabletype' => '<a href="http://www.movabletype.org/docs/mtmanual_programmatic.html">Moveable Type API</a>')); case 'admin/modules#description': - return t('Enable users to post using applications that support XML-RPC blog APIs'); + return t('Enable users to post using applications that support XML-RPC blog APIs.'); } } diff --git a/modules/book.module b/modules/book.module index 4dcdf18fb..1a30c2929 100644 --- a/modules/book.module +++ b/modules/book.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Allows users to collaboratively author a book. + */ + +/** * Implementation of hook_node_name(). */ function book_node_name($node) { diff --git a/modules/book/book.module b/modules/book/book.module index 4dcdf18fb..1a30c2929 100644 --- a/modules/book/book.module +++ b/modules/book/book.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Allows users to collaboratively author a book. + */ + +/** * Implementation of hook_node_name(). */ function book_node_name($node) { diff --git a/modules/comment.module b/modules/comment.module index 082c150a4..0f9980b67 100644 --- a/modules/comment.module +++ b/modules/comment.module @@ -3,8 +3,7 @@ /** * @file - * - * Enables user to comment on published content. + * Enables users to comment on published content. * * When enabled, the Drupal comment module creates a discussion * board for each Drupal node. Users can post comments to discuss diff --git a/modules/comment/comment.module b/modules/comment/comment.module index 082c150a4..0f9980b67 100644 --- a/modules/comment/comment.module +++ b/modules/comment/comment.module @@ -3,8 +3,7 @@ /** * @file - * - * Enables user to comment on published content. + * Enables users to comment on published content. * * When enabled, the Drupal comment module creates a discussion * board for each Drupal node. Users can post comments to discuss diff --git a/modules/drupal.module b/modules/drupal.module index bae7ebfbd..b5f417f72 100644 --- a/modules/drupal.module +++ b/modules/drupal.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Lets users log in using a Drupal ID and can notify a central server about your site. + */ + +/** * Implementation of hook_help(). */ function drupal_help($section) { diff --git a/modules/drupal/drupal.module b/modules/drupal/drupal.module index bae7ebfbd..b5f417f72 100644 --- a/modules/drupal/drupal.module +++ b/modules/drupal/drupal.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Lets users log in using a Drupal ID and can notify a central server about your site. + */ + +/** * Implementation of hook_help(). */ function drupal_help($section) { diff --git a/modules/filter.module b/modules/filter.module index 612a2b037..e952e9301 100644 --- a/modules/filter.module +++ b/modules/filter.module @@ -1,6 +1,11 @@ <?php // $Id$ +/** + * @file + * Framework for handling filtering of content. + */ + define('FILTER_FORMAT_DEFAULT', 0); define('FILTER_HTML_STRIP', 1); diff --git a/modules/filter/filter.module b/modules/filter/filter.module index 612a2b037..e952e9301 100644 --- a/modules/filter/filter.module +++ b/modules/filter/filter.module @@ -1,6 +1,11 @@ <?php // $Id$ +/** + * @file + * Framework for handling filtering of content. + */ + define('FILTER_FORMAT_DEFAULT', 0); define('FILTER_HTML_STRIP', 1); diff --git a/modules/forum.module b/modules/forum.module index 5d633de70..e90df6d9c 100644 --- a/modules/forum.module +++ b/modules/forum.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enable threaded discussions about general topics. + */ + +/** * Implementation of hook_help(). */ function forum_help($section) { diff --git a/modules/forum/forum.module b/modules/forum/forum.module index 5d633de70..e90df6d9c 100644 --- a/modules/forum/forum.module +++ b/modules/forum/forum.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enable threaded discussions about general topics. + */ + +/** * Implementation of hook_help(). */ function forum_help($section) { diff --git a/modules/help.module b/modules/help.module index 5c68212df..1fb68e743 100644 --- a/modules/help.module +++ b/modules/help.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Manages displaying online help. + */ + +/** * Implementation of hook_menu(). */ function help_menu() { diff --git a/modules/help/help.module b/modules/help/help.module index 5c68212df..1fb68e743 100644 --- a/modules/help/help.module +++ b/modules/help/help.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Manages displaying online help. + */ + +/** * Implementation of hook_menu(). */ function help_menu() { diff --git a/modules/locale.module b/modules/locale.module index ee1458249..836cb5089 100644 --- a/modules/locale.module +++ b/modules/locale.module @@ -3,7 +3,6 @@ /** * @file - * * Enables administrators to manage the site interface languages. * * When enabled, the site interface can be displayed in different diff --git a/modules/locale/locale.module b/modules/locale/locale.module index ee1458249..836cb5089 100644 --- a/modules/locale/locale.module +++ b/modules/locale/locale.module @@ -3,7 +3,6 @@ /** * @file - * * Enables administrators to manage the site interface languages. * * When enabled, the site interface can be displayed in different diff --git a/modules/menu.module b/modules/menu.module index c90536c0f..916c31903 100644 --- a/modules/menu.module +++ b/modules/menu.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Allows administrators to customize the site navigation menu. + */ + +/** * Implementation of hook_menu(). */ function menu_menu() { diff --git a/modules/menu/menu.module b/modules/menu/menu.module index c90536c0f..916c31903 100644 --- a/modules/menu/menu.module +++ b/modules/menu/menu.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Allows administrators to customize the site navigation menu. + */ + +/** * Implementation of hook_menu(). */ function menu_menu() { diff --git a/modules/node.module b/modules/node.module index 90abd53e9..9ea8d1052 100644 --- a/modules/node.module +++ b/modules/node.module @@ -1,6 +1,11 @@ <?php // $Id$ +/** + * @file + * The core that allows content to be submitted to the site. + */ + define('NODE_NEW_LIMIT', time() - 30 * 24 * 60 * 60); /** diff --git a/modules/node/node.module b/modules/node/node.module index 90abd53e9..9ea8d1052 100644 --- a/modules/node/node.module +++ b/modules/node/node.module @@ -1,6 +1,11 @@ <?php // $Id$ +/** + * @file + * The core that allows content to be submitted to the site. + */ + define('NODE_NEW_LIMIT', time() - 30 * 24 * 60 * 60); /** diff --git a/modules/page.module b/modules/page.module index 4d0336172..6dc7c2441 100644 --- a/modules/page.module +++ b/modules/page.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables the creation of pages that can be added to the navigation system. + */ + +/** * Implementation of hook_help(). */ function page_help($section) { diff --git a/modules/page/page.module b/modules/page/page.module index 4d0336172..6dc7c2441 100644 --- a/modules/page/page.module +++ b/modules/page/page.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables the creation of pages that can be added to the navigation system. + */ + +/** * Implementation of hook_help(). */ function page_help($section) { diff --git a/modules/path.module b/modules/path.module index 52279451d..daa53bf58 100644 --- a/modules/path.module +++ b/modules/path.module @@ -2,6 +2,11 @@ /* $Id$ */ /** + * @file + * Enables users to rename URLs. + */ + +/** * Implementation of hook_help(). */ function path_help($section) { diff --git a/modules/path/path.module b/modules/path/path.module index 52279451d..daa53bf58 100644 --- a/modules/path/path.module +++ b/modules/path/path.module @@ -2,6 +2,11 @@ /* $Id$ */ /** + * @file + * Enables users to rename URLs. + */ + +/** * Implementation of hook_help(). */ function path_help($section) { diff --git a/modules/ping.module b/modules/ping.module index ed0538def..429646fb8 100644 --- a/modules/ping.module +++ b/modules/ping.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Alerts other sites that your site has been updated. + */ + +/** * Implementation of hook_help(). */ function ping_help($section) { diff --git a/modules/ping/ping.module b/modules/ping/ping.module index ed0538def..429646fb8 100644 --- a/modules/ping/ping.module +++ b/modules/ping/ping.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Alerts other sites that your site has been updated. + */ + +/** * Implementation of hook_help(). */ function ping_help($section) { diff --git a/modules/poll.module b/modules/poll.module index bb0f2df79..34209894d 100644 --- a/modules/poll.module +++ b/modules/poll.module @@ -2,6 +2,12 @@ // $Id$ /** + * @file + * Enables your site to capture votes on different topics in the form of multiple + * choice questions. + */ + +/** * Implementation of hook_help(). */ function poll_help($section) { diff --git a/modules/poll/poll.module b/modules/poll/poll.module index bb0f2df79..34209894d 100644 --- a/modules/poll/poll.module +++ b/modules/poll/poll.module @@ -2,6 +2,12 @@ // $Id$ /** + * @file + * Enables your site to capture votes on different topics in the form of multiple + * choice questions. + */ + +/** * Implementation of hook_help(). */ function poll_help($section) { diff --git a/modules/profile.module b/modules/profile.module index 9d43d5aef..e379d75db 100644 --- a/modules/profile.module +++ b/modules/profile.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Support for configurable user profiles. + */ + +/** * Flags to define the visibility of a profile field. */ define('PROFILE_PRIVATE', 1); diff --git a/modules/profile/profile.module b/modules/profile/profile.module index 9d43d5aef..e379d75db 100644 --- a/modules/profile/profile.module +++ b/modules/profile/profile.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Support for configurable user profiles. + */ + +/** * Flags to define the visibility of a profile field. */ define('PROFILE_PRIVATE', 1); diff --git a/modules/queue.module b/modules/queue.module index 3aefe0102..a0f9923b6 100644 --- a/modules/queue.module +++ b/modules/queue.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables content to be moderated by the community. + */ + +/** * Implementation of hook_help(). */ function queue_help($section) { diff --git a/modules/search.module b/modules/search.module index 68262ff63..4143cfda2 100644 --- a/modules/search.module +++ b/modules/search.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables site-wide keyword searching. + */ + +/** * Implementation of hook_help(). */ function search_help($section = 'admin/help#search') { diff --git a/modules/search/search.module b/modules/search/search.module index 68262ff63..4143cfda2 100644 --- a/modules/search/search.module +++ b/modules/search/search.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables site-wide keyword searching. + */ + +/** * Implementation of hook_help(). */ function search_help($section = 'admin/help#search') { diff --git a/modules/statistics.module b/modules/statistics.module index 0634806d4..61e260043 100644 --- a/modules/statistics.module +++ b/modules/statistics.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Logs access statistics for your site. + */ + +/** * Implementation of hook_help(). */ function statistics_help($section) { diff --git a/modules/statistics/statistics.module b/modules/statistics/statistics.module index 0634806d4..61e260043 100644 --- a/modules/statistics/statistics.module +++ b/modules/statistics/statistics.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Logs access statistics for your site. + */ + +/** * Implementation of hook_help(). */ function statistics_help($section) { diff --git a/modules/story.module b/modules/story.module index 8000ed6c2..f7b06782a 100644 --- a/modules/story.module +++ b/modules/story.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables users to submit stories, articles or similar content. + */ + +/** * Implementation of hook_help(). */ function story_help($section) { diff --git a/modules/story/story.module b/modules/story/story.module index 8000ed6c2..f7b06782a 100644 --- a/modules/story/story.module +++ b/modules/story/story.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables users to submit stories, articles or similar content. + */ + +/** * Implementation of hook_help(). */ function story_help($section) { diff --git a/modules/system.module b/modules/system.module index ee5015992..96d2b14cf 100644 --- a/modules/system.module +++ b/modules/system.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Configuration system that lets administrators modify the workings of the site. + */ + +/** * Implementation of hook_help(). */ function system_help($section) { diff --git a/modules/system/system.module b/modules/system/system.module index ee5015992..96d2b14cf 100644 --- a/modules/system/system.module +++ b/modules/system/system.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Configuration system that lets administrators modify the workings of the site. + */ + +/** * Implementation of hook_help(). */ function system_help($section) { diff --git a/modules/taxonomy.module b/modules/taxonomy.module index 72a4c2889..13ce8b4f7 100644 --- a/modules/taxonomy.module +++ b/modules/taxonomy.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables the organization of content into categories. + */ + +/** * Implementation of hook_perm(). */ function taxonomy_perm() { diff --git a/modules/taxonomy/taxonomy.module b/modules/taxonomy/taxonomy.module index 72a4c2889..13ce8b4f7 100644 --- a/modules/taxonomy/taxonomy.module +++ b/modules/taxonomy/taxonomy.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables the organization of content into categories. + */ + +/** * Implementation of hook_perm(). */ function taxonomy_perm() { diff --git a/modules/throttle.module b/modules/throttle.module index c093857d9..edabde4e6 100644 --- a/modules/throttle.module +++ b/modules/throttle.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Allows configuration of congestion control auto-throttle mechanism. + */ + +/** * Determine the current load on the site. * * Call the throttle_status() function from your own modules, themes, blocks, diff --git a/modules/throttle/throttle.module b/modules/throttle/throttle.module index c093857d9..edabde4e6 100644 --- a/modules/throttle/throttle.module +++ b/modules/throttle/throttle.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Allows configuration of congestion control auto-throttle mechanism. + */ + +/** * Determine the current load on the site. * * Call the throttle_status() function from your own modules, themes, blocks, diff --git a/modules/tracker.module b/modules/tracker.module index fcf057d83..ef406194f 100644 --- a/modules/tracker.module +++ b/modules/tracker.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables tracking of recent posts for users. + */ + +/** * Implementation of hook_help(). */ function tracker_help($section) { diff --git a/modules/tracker/tracker.module b/modules/tracker/tracker.module index fcf057d83..ef406194f 100644 --- a/modules/tracker/tracker.module +++ b/modules/tracker/tracker.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables tracking of recent posts for users. + */ + +/** * Implementation of hook_help(). */ function tracker_help($section) { diff --git a/modules/upload.module b/modules/upload.module index 12afc4039..58e9f2d56 100644 --- a/modules/upload.module +++ b/modules/upload.module @@ -1,6 +1,11 @@ <?php /* $Id$ */ +/** + * @file + * File-handling and attaching files to nodes. + */ + function upload_help($section) { switch ($section) { case 'admin/modules#description': diff --git a/modules/upload/upload.module b/modules/upload/upload.module index 12afc4039..58e9f2d56 100644 --- a/modules/upload/upload.module +++ b/modules/upload/upload.module @@ -1,6 +1,11 @@ <?php /* $Id$ */ +/** + * @file + * File-handling and attaching files to nodes. + */ + function upload_help($section) { switch ($section) { case 'admin/modules#description': diff --git a/modules/user.module b/modules/user.module index 27188ad39..915d3414f 100644 --- a/modules/user.module +++ b/modules/user.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables the user registration and login system. + */ + +/** * Invokes hook_user() in every module. * * We cannot use module_invoke() for this, becuse the arguments need to diff --git a/modules/user/user.module b/modules/user/user.module index 27188ad39..915d3414f 100644 --- a/modules/user/user.module +++ b/modules/user/user.module @@ -2,6 +2,11 @@ // $Id$ /** + * @file + * Enables the user registration and login system. + */ + +/** * Invokes hook_user() in every module. * * We cannot use module_invoke() for this, becuse the arguments need to diff --git a/modules/watchdog.module b/modules/watchdog.module index 3a3ad74f1..c37ff3b2b 100644 --- a/modules/watchdog.module +++ b/modules/watchdog.module @@ -3,7 +3,6 @@ /** * @file - * * System monitoring and logging for administrators. * * The watchdog module monitors your site and keeps a list of diff --git a/modules/watchdog/watchdog.module b/modules/watchdog/watchdog.module index 3a3ad74f1..c37ff3b2b 100644 --- a/modules/watchdog/watchdog.module +++ b/modules/watchdog/watchdog.module @@ -3,7 +3,6 @@ /** * @file - * * System monitoring and logging for administrators. * * The watchdog module monitors your site and keeps a list of |