From 94e30bf7761f5857945df906ae5ba7da5c2fc9b5 Mon Sep 17 00:00:00 2001
From: Dries Buytaert <dries@buytaert.net>
Date: Sat, 21 Aug 2004 06:42:38 +0000
Subject: [PATCH] - 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.
---
cron.php | 5 +++++
database/updates.inc | 5 +++++
includes/conf.php | 5 +++++
includes/file.inc | 5 +++++
includes/locale.inc | 5 ++---
includes/session.inc | 5 +++++
index.php | 8 +++++++
modules/admin.module | 5 +++++
modules/aggregator.module | 5 +++++
modules/aggregator/aggregator.module | 5 +++++
modules/archive.module | 5 +++++
modules/archive/archive.module | 5 +++++
modules/block.module | 5 +++++
modules/block/block.module | 5 +++++
modules/blog.module | 5 +++++
modules/blog/blog.module | 5 +++++
modules/blogapi.module | 7 +++++-
modules/blogapi/blogapi.module | 7 +++++-
modules/book.module | 5 +++++
modules/book/book.module | 5 +++++
modules/comment.module | 3 +--
modules/comment/comment.module | 3 +--
modules/drupal.module | 5 +++++
modules/drupal/drupal.module | 5 +++++
modules/filter.module | 5 +++++
modules/filter/filter.module | 5 +++++
modules/forum.module | 5 +++++
modules/forum/forum.module | 5 +++++
modules/help.module | 5 +++++
modules/help/help.module | 5 +++++
modules/locale.module | 1 -
modules/locale/locale.module | 1 -
modules/menu.module | 5 +++++
modules/menu/menu.module | 5 +++++
modules/node.module | 5 +++++
modules/node/node.module | 5 +++++
modules/page.module | 5 +++++
modules/page/page.module | 5 +++++
modules/path.module | 5 +++++
modules/path/path.module | 5 +++++
modules/ping.module | 5 +++++
modules/ping/ping.module | 5 +++++
modules/poll.module | 6 ++++++
modules/poll/poll.module | 6 ++++++
modules/profile.module | 5 +++++
modules/profile/profile.module | 5 +++++
modules/queue.module | 5 +++++
modules/search.module | 5 +++++
modules/search/search.module | 5 +++++
modules/statistics.module | 5 +++++
modules/statistics/statistics.module | 5 +++++
modules/story.module | 5 +++++
modules/story/story.module | 5 +++++
modules/system.module | 5 +++++
modules/system/system.module | 5 +++++
modules/taxonomy.module | 5 +++++
modules/taxonomy/taxonomy.module | 5 +++++
modules/throttle.module | 5 +++++
modules/throttle/throttle.module | 5 +++++
modules/tracker.module | 5 +++++
modules/tracker/tracker.module | 5 +++++
modules/upload.module | 5 +++++
modules/upload/upload.module | 5 +++++
modules/user.module | 5 +++++
modules/user/user.module | 5 +++++
modules/watchdog.module | 1 -
modules/watchdog/watchdog.module | 1 -
themes/chameleon/chameleon.theme | 5 +++++
themes/engines/xtemplate/xtemplate.engine | 5 +++++
update.php | 26 ++++++++++++-----------
xmlrpc.php | 5 +++++
71 files changed, 340 insertions(+), 25 deletions(-)
diff --git a/cron.php b/cron.php
index 31790bca81b0..84927b75e721 100644
--- a/cron.php
+++ b/cron.php
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Handles incoming requests to fire of regularly-scheduled tasks (cron jobs).
+ */
+
include_once 'includes/bootstrap.inc';
include_once 'includes/common.inc' ;
diff --git a/database/updates.inc b/database/updates.inc
index 61186b6a194b..e2332c16c079 100644
--- a/database/updates.inc
+++ b/database/updates.inc
@@ -1,6 +1,11 @@
<?php
/* $Id$ */
+/**
+ * @file
+ * All incremental database updates performed between Drupal releases.
+ */
+
// Define the various updates in an array("date : comment" => "function");
$sql_updates = array(
"2002-06-22: first update since Drupal 4.0.0 release" => "update_32",
diff --git a/includes/conf.php b/includes/conf.php
index 0c78ed344f9a..3f04f1bccefa 100644
--- a/includes/conf.php
+++ b/includes/conf.php
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Drupal site-specific configuration file.
+ */
+
#
# Database settings:
#
diff --git a/includes/file.inc b/includes/file.inc
index 6eb0bfd3d723..a8f447b76506 100644
--- a/includes/file.inc
+++ b/includes/file.inc
@@ -1,6 +1,11 @@
<?php
/* $Id$ */
+/**
+ * @file
+ * API for handling file uploads and server file management.
+ */
+
/**
* @defgroup file File interface
* Common file handling functions.
diff --git a/includes/locale.inc b/includes/locale.inc
index 986fc19a15a1..93c05065ffb6 100644
--- a/includes/locale.inc
+++ b/includes/locale.inc
@@ -1,10 +1,9 @@
<?php
// $Id$
+
/**
* @file
- *
- * Admin related functions for locale.module
- *
+ * Admin-related functions for locale.module.
*/
// ---------------------------------------------------------------------------------
diff --git a/includes/session.inc b/includes/session.inc
index 277885eae164..91351d7d4fc6 100644
--- a/includes/session.inc
+++ b/includes/session.inc
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * User session handling functions.
+ */
+
session_set_save_handler("sess_open", "sess_close", "sess_read", "sess_write", "sess_destroy", "sess_gc");
session_start();
diff --git a/index.php b/index.php
index c7e2e297b940..89f8354f96a9 100644
--- a/index.php
+++ b/index.php
@@ -1,6 +1,14 @@
<?php
// $Id$
+/**
+ * @file
+ * The PHP page that serves all page requests on a Drupal installation.
+ *
+ * The routines here dispatch control to the appropriate handler, which then
+ * prints the appropriate page.
+ */
+
include_once 'includes/bootstrap.inc';
drupal_page_header();
include_once 'includes/common.inc';
diff --git a/modules/admin.module b/modules/admin.module
index 3bb035246a73..d528c2d49c3f 100644
--- a/modules/admin.module
+++ b/modules/admin.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Handles the administration pages.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/aggregator.module b/modules/aggregator.module
index 77e0cf6f2abc..65cfbf52acb1 100644
--- a/modules/aggregator.module
+++ b/modules/aggregator.module
@@ -1,6 +1,11 @@
<?php
/* $Id$ */
+/**
+ * @file
+ * Used to aggregate syndicated content (RSS and RDF).
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/aggregator/aggregator.module b/modules/aggregator/aggregator.module
index 77e0cf6f2abc..65cfbf52acb1 100644
--- a/modules/aggregator/aggregator.module
+++ b/modules/aggregator/aggregator.module
@@ -1,6 +1,11 @@
<?php
/* $Id$ */
+/**
+ * @file
+ * Used to aggregate syndicated content (RSS and RDF).
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/archive.module b/modules/archive.module
index 359d9e189647..57bea34199e3 100644
--- a/modules/archive.module
+++ b/modules/archive.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Displays a calendar to navigate old content.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/archive/archive.module b/modules/archive/archive.module
index 359d9e189647..57bea34199e3 100644
--- a/modules/archive/archive.module
+++ b/modules/archive/archive.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Displays a calendar to navigate old content.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/block.module b/modules/block.module
index 7a755f7e7607..5ecf0f9ae0c5 100644
--- a/modules/block.module
+++ b/modules/block.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Controls the boxes that are displayed around the main content.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/block/block.module b/modules/block/block.module
index 7a755f7e7607..5ecf0f9ae0c5 100644
--- a/modules/block/block.module
+++ b/modules/block/block.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Controls the boxes that are displayed around the main content.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/blog.module b/modules/blog.module
index cbbf70edb10e..a40bb64b33a7 100644
--- a/modules/blog.module
+++ b/modules/blog.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables keeping an easily and regularly updated web page or a blog.
+ */
+
/**
* Implementation of hook_settings().
*/
diff --git a/modules/blog/blog.module b/modules/blog/blog.module
index cbbf70edb10e..a40bb64b33a7 100644
--- a/modules/blog/blog.module
+++ b/modules/blog/blog.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables keeping an easily and regularly updated web page or a blog.
+ */
+
/**
* Implementation of hook_settings().
*/
diff --git a/modules/blogapi.module b/modules/blogapi.module
index af20f89e25b9..ef902edb89f4 100644
--- a/modules/blogapi.module
+++ b/modules/blogapi.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enable users to post using applications that support XML-RPC blog APIs.
+ */
+
/**
* Implementation of hook_help().
*/
@@ -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 af20f89e25b9..ef902edb89f4 100644
--- a/modules/blogapi/blogapi.module
+++ b/modules/blogapi/blogapi.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enable users to post using applications that support XML-RPC blog APIs.
+ */
+
/**
* Implementation of hook_help().
*/
@@ -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 4dcdf18fbb50..1a30c292980d 100644
--- a/modules/book.module
+++ b/modules/book.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Allows users to collaboratively author a book.
+ */
+
/**
* Implementation of hook_node_name().
*/
diff --git a/modules/book/book.module b/modules/book/book.module
index 4dcdf18fbb50..1a30c292980d 100644
--- a/modules/book/book.module
+++ b/modules/book/book.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Allows users to collaboratively author a book.
+ */
+
/**
* Implementation of hook_node_name().
*/
diff --git a/modules/comment.module b/modules/comment.module
index 082c150a4930..0f9980b67c98 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 082c150a4930..0f9980b67c98 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 bae7ebfbdc59..b5f417f72575 100644
--- a/modules/drupal.module
+++ b/modules/drupal.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Lets users log in using a Drupal ID and can notify a central server about your site.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/drupal/drupal.module b/modules/drupal/drupal.module
index bae7ebfbdc59..b5f417f72575 100644
--- a/modules/drupal/drupal.module
+++ b/modules/drupal/drupal.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Lets users log in using a Drupal ID and can notify a central server about your site.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/filter.module b/modules/filter.module
index 612a2b037942..e952e9301891 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 612a2b037942..e952e9301891 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 5d633de70a55..e90df6d9cbf4 100644
--- a/modules/forum.module
+++ b/modules/forum.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enable threaded discussions about general topics.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/forum/forum.module b/modules/forum/forum.module
index 5d633de70a55..e90df6d9cbf4 100644
--- a/modules/forum/forum.module
+++ b/modules/forum/forum.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enable threaded discussions about general topics.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/help.module b/modules/help.module
index 5c68212dfff2..1fb68e74337d 100644
--- a/modules/help.module
+++ b/modules/help.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Manages displaying online help.
+ */
+
/**
* Implementation of hook_menu().
*/
diff --git a/modules/help/help.module b/modules/help/help.module
index 5c68212dfff2..1fb68e74337d 100644
--- a/modules/help/help.module
+++ b/modules/help/help.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Manages displaying online help.
+ */
+
/**
* Implementation of hook_menu().
*/
diff --git a/modules/locale.module b/modules/locale.module
index ee1458249895..836cb5089085 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 ee1458249895..836cb5089085 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 c90536c0ff13..916c31903695 100644
--- a/modules/menu.module
+++ b/modules/menu.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Allows administrators to customize the site navigation menu.
+ */
+
/**
* Implementation of hook_menu().
*/
diff --git a/modules/menu/menu.module b/modules/menu/menu.module
index c90536c0ff13..916c31903695 100644
--- a/modules/menu/menu.module
+++ b/modules/menu/menu.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Allows administrators to customize the site navigation menu.
+ */
+
/**
* Implementation of hook_menu().
*/
diff --git a/modules/node.module b/modules/node.module
index 90abd53e907a..9ea8d10529b1 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 90abd53e907a..9ea8d10529b1 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 4d03361722ca..6dc7c2441640 100644
--- a/modules/page.module
+++ b/modules/page.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables the creation of pages that can be added to the navigation system.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/page/page.module b/modules/page/page.module
index 4d03361722ca..6dc7c2441640 100644
--- a/modules/page/page.module
+++ b/modules/page/page.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables the creation of pages that can be added to the navigation system.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/path.module b/modules/path.module
index 52279451d1a4..daa53bf589e8 100644
--- a/modules/path.module
+++ b/modules/path.module
@@ -1,6 +1,11 @@
<?php
/* $Id$ */
+/**
+ * @file
+ * Enables users to rename URLs.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/path/path.module b/modules/path/path.module
index 52279451d1a4..daa53bf589e8 100644
--- a/modules/path/path.module
+++ b/modules/path/path.module
@@ -1,6 +1,11 @@
<?php
/* $Id$ */
+/**
+ * @file
+ * Enables users to rename URLs.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/ping.module b/modules/ping.module
index ed0538defe29..429646fb8375 100644
--- a/modules/ping.module
+++ b/modules/ping.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Alerts other sites that your site has been updated.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/ping/ping.module b/modules/ping/ping.module
index ed0538defe29..429646fb8375 100644
--- a/modules/ping/ping.module
+++ b/modules/ping/ping.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Alerts other sites that your site has been updated.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/poll.module b/modules/poll.module
index bb0f2df79311..34209894d6c7 100644
--- a/modules/poll.module
+++ b/modules/poll.module
@@ -1,6 +1,12 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables your site to capture votes on different topics in the form of multiple
+ * choice questions.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/poll/poll.module b/modules/poll/poll.module
index bb0f2df79311..34209894d6c7 100644
--- a/modules/poll/poll.module
+++ b/modules/poll/poll.module
@@ -1,6 +1,12 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables your site to capture votes on different topics in the form of multiple
+ * choice questions.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/profile.module b/modules/profile.module
index 9d43d5aef85f..e379d75db3d0 100644
--- a/modules/profile.module
+++ b/modules/profile.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Support for configurable user profiles.
+ */
+
/**
* Flags to define the visibility of a profile field.
*/
diff --git a/modules/profile/profile.module b/modules/profile/profile.module
index 9d43d5aef85f..e379d75db3d0 100644
--- a/modules/profile/profile.module
+++ b/modules/profile/profile.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Support for configurable user profiles.
+ */
+
/**
* Flags to define the visibility of a profile field.
*/
diff --git a/modules/queue.module b/modules/queue.module
index 3aefe0102261..a0f9923b6b01 100644
--- a/modules/queue.module
+++ b/modules/queue.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables content to be moderated by the community.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/search.module b/modules/search.module
index 68262ff63395..4143cfda2223 100644
--- a/modules/search.module
+++ b/modules/search.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables site-wide keyword searching.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/search/search.module b/modules/search/search.module
index 68262ff63395..4143cfda2223 100644
--- a/modules/search/search.module
+++ b/modules/search/search.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables site-wide keyword searching.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/statistics.module b/modules/statistics.module
index 0634806d4e64..61e2600439e9 100644
--- a/modules/statistics.module
+++ b/modules/statistics.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Logs access statistics for your site.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/statistics/statistics.module b/modules/statistics/statistics.module
index 0634806d4e64..61e2600439e9 100644
--- a/modules/statistics/statistics.module
+++ b/modules/statistics/statistics.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Logs access statistics for your site.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/story.module b/modules/story.module
index 8000ed6c20a2..f7b06782a54a 100644
--- a/modules/story.module
+++ b/modules/story.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables users to submit stories, articles or similar content.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/story/story.module b/modules/story/story.module
index 8000ed6c20a2..f7b06782a54a 100644
--- a/modules/story/story.module
+++ b/modules/story/story.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables users to submit stories, articles or similar content.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/system.module b/modules/system.module
index ee501599261a..96d2b14cfc75 100644
--- a/modules/system.module
+++ b/modules/system.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Configuration system that lets administrators modify the workings of the site.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/system/system.module b/modules/system/system.module
index ee501599261a..96d2b14cfc75 100644
--- a/modules/system/system.module
+++ b/modules/system/system.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Configuration system that lets administrators modify the workings of the site.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/taxonomy.module b/modules/taxonomy.module
index 72a4c2889f0b..13ce8b4f7dc2 100644
--- a/modules/taxonomy.module
+++ b/modules/taxonomy.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables the organization of content into categories.
+ */
+
/**
* Implementation of hook_perm().
*/
diff --git a/modules/taxonomy/taxonomy.module b/modules/taxonomy/taxonomy.module
index 72a4c2889f0b..13ce8b4f7dc2 100644
--- a/modules/taxonomy/taxonomy.module
+++ b/modules/taxonomy/taxonomy.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables the organization of content into categories.
+ */
+
/**
* Implementation of hook_perm().
*/
diff --git a/modules/throttle.module b/modules/throttle.module
index c093857d9f51..edabde4e6aab 100644
--- a/modules/throttle.module
+++ b/modules/throttle.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Allows configuration of congestion control auto-throttle mechanism.
+ */
+
/**
* Determine the current load on the site.
*
diff --git a/modules/throttle/throttle.module b/modules/throttle/throttle.module
index c093857d9f51..edabde4e6aab 100644
--- a/modules/throttle/throttle.module
+++ b/modules/throttle/throttle.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Allows configuration of congestion control auto-throttle mechanism.
+ */
+
/**
* Determine the current load on the site.
*
diff --git a/modules/tracker.module b/modules/tracker.module
index fcf057d8307d..ef406194fbb7 100644
--- a/modules/tracker.module
+++ b/modules/tracker.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables tracking of recent posts for users.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/tracker/tracker.module b/modules/tracker/tracker.module
index fcf057d8307d..ef406194fbb7 100644
--- a/modules/tracker/tracker.module
+++ b/modules/tracker/tracker.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables tracking of recent posts for users.
+ */
+
/**
* Implementation of hook_help().
*/
diff --git a/modules/upload.module b/modules/upload.module
index 12afc40397e3..58e9f2d562ab 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 12afc40397e3..58e9f2d562ab 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 27188ad3948c..915d3414fbe2 100644
--- a/modules/user.module
+++ b/modules/user.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables the user registration and login system.
+ */
+
/**
* Invokes hook_user() in every module.
*
diff --git a/modules/user/user.module b/modules/user/user.module
index 27188ad3948c..915d3414fbe2 100644
--- a/modules/user/user.module
+++ b/modules/user/user.module
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Enables the user registration and login system.
+ */
+
/**
* Invokes hook_user() in every module.
*
diff --git a/modules/watchdog.module b/modules/watchdog.module
index 3a3ad74f1221..c37ff3b2b6f6 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 3a3ad74f1221..c37ff3b2b6f6 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
diff --git a/themes/chameleon/chameleon.theme b/themes/chameleon/chameleon.theme
index c449d8f469ce..44df7589b75a 100644
--- a/themes/chameleon/chameleon.theme
+++ b/themes/chameleon/chameleon.theme
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * A slim, CSS-driven theme.
+ */
+
function chameleon_features() {
return array(
'logo',
diff --git a/themes/engines/xtemplate/xtemplate.engine b/themes/engines/xtemplate/xtemplate.engine
index 0a795f32cb75..6bcffc65a133 100644
--- a/themes/engines/xtemplate/xtemplate.engine
+++ b/themes/engines/xtemplate/xtemplate.engine
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * Handles the interface between XTemplate files and the Drupal theme system.
+ */
+
// Initialize the xtemplate engine.
function xtemplate_init($template) {
// We cannot use the theme() or path_to_theme() functions here
diff --git a/update.php b/update.php
index f021cea84537..200493fb6e12 100644
--- a/update.php
+++ b/update.php
@@ -1,19 +1,21 @@
<?php
// $Id$
-/*
-** USAGE:
-**
-** - Point your browser to "http://www.site.com/update.php" and follow
-** the instructions.
-**
-** - If you are not logged in as administrator, you will need to modify the
-** statement below. Change the 1 into a 0 to disable the access check.
-** After finishing the upgrade, open this file and change the 0 back into
-** a 1!
-*/
+
+/**
+ * @file
+ * Administrative page for handling updates from one Drupal version to another.
+ *
+ * Point your browser to "http://www.site.com/update.php" and follow the
+ * instructions.
+ *
+ * If you are not logged in as administrator, you will need to modify the access
+ * check statement below. Change the TRUE into a FALSE to disable the access
+ * check. After finishing the upgrade, be sure to open this file and change the
+ * FALSE back into a TRUE!
+ */
// Disable access checking?
-$access_check = 1;
+$access_check = TRUE;
if (!ini_get("safe_mode")) {
set_time_limit(180);
diff --git a/xmlrpc.php b/xmlrpc.php
index 7b52d5166891..11f6ab74f281 100644
--- a/xmlrpc.php
+++ b/xmlrpc.php
@@ -1,6 +1,11 @@
<?php
// $Id$
+/**
+ * @file
+ * PHP page for handling incoming XML-RPC requests from clients.
+ */
+
include_once 'includes/bootstrap.inc';
include_once 'includes/common.inc';
include_once 'includes/xmlrpc.inc';
--
GitLab