Commit 94e30bf7 authored by Dries's avatar Dries

- Patch by JonBob: for consistency and readability, add brief descriptions of...

- 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.
parent 6696028a
<?php
// $Id$
/**
* @file
* Handles incoming requests to fire of regularly-scheduled tasks (cron jobs).
*/
include_once 'includes/bootstrap.inc';
include_once 'includes/common.inc' ;
......
<?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",
......
<?php
// $Id$
/**
* @file
* Drupal site-specific configuration file.
*/
#
# Database settings:
#
......
<?php
/* $Id$ */
/**
* @file
* API for handling file uploads and server file management.
*/
/**
* @defgroup file File interface
* Common file handling functions.
......
<?php
// $Id$
/**
* @file
*
* Admin related functions for locale.module
*
* Admin-related functions for locale.module.
*/
// ---------------------------------------------------------------------------------
......
<?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();
......
<?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';
......
<?php
// $Id$
/**
* @file
* Handles the administration pages.
*/
/**
* Implementation of hook_help().
*/
......
<?php
/* $Id$ */
/**
* @file
* Used to aggregate syndicated content (RSS and RDF).
*/
/**
* Implementation of hook_help().
*/
......
<?php
/* $Id$ */
/**
* @file
* Used to aggregate syndicated content (RSS and RDF).
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Displays a calendar to navigate old content.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Displays a calendar to navigate old content.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Controls the boxes that are displayed around the main content.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Controls the boxes that are displayed around the main content.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Enables keeping an easily and regularly updated web page or a blog.
*/
/**
* Implementation of hook_settings().
*/
......
<?php
// $Id$
/**
* @file
* Enables keeping an easily and regularly updated web page or a blog.
*/
/**
* Implementation of hook_settings().
*/
......
<?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.');
}
}
......
<?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.');
}
}
......
<?php
// $Id$
/**
* @file
* Allows users to collaboratively author a book.
*/
/**
* Implementation of hook_node_name().
*/
......
<?php
// $Id$
/**
* @file
* Allows users to collaboratively author a book.
*/
/**
* Implementation of hook_node_name().
*/
......
......@@ -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
......
......@@ -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
......
<?php
// $Id$
/**
* @file
* Lets users log in using a Drupal ID and can notify a central server about your site.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Lets users log in using a Drupal ID and can notify a central server about your site.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Framework for handling filtering of content.
*/
define('FILTER_FORMAT_DEFAULT', 0);
define('FILTER_HTML_STRIP', 1);
......
<?php
// $Id$
/**
* @file
* Framework for handling filtering of content.
*/
define('FILTER_FORMAT_DEFAULT', 0);
define('FILTER_HTML_STRIP', 1);
......
<?php
// $Id$
/**
* @file
* Enable threaded discussions about general topics.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Enable threaded discussions about general topics.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Manages displaying online help.
*/
/**
* Implementation of hook_menu().
*/
......
<?php
// $Id$
/**
* @file
* Manages displaying online help.
*/
/**
* Implementation of hook_menu().
*/
......
......@@ -3,7 +3,6 @@
/**
* @file
*
* Enables administrators to manage the site interface languages.
*
* When enabled, the site interface can be displayed in different
......
......@@ -3,7 +3,6 @@
/**
* @file
*
* Enables administrators to manage the site interface languages.
*
* When enabled, the site interface can be displayed in different
......
<?php
// $Id$
/**
* @file
* Allows administrators to customize the site navigation menu.
*/
/**
* Implementation of hook_menu().
*/
......
<?php
// $Id$
/**
* @file
* Allows administrators to customize the site navigation menu.
*/
/**
* Implementation of hook_menu().
*/
......
<?php
// $Id$
/**
* @file
* The core that allows content to be submitted to the site.
*/
define('NODE_NEW_LIMIT', time() - 30 * 24 * 60 * 60);
/**
......
<?php
// $Id$
/**
* @file
* The core that allows content to be submitted to the site.
*/
define('NODE_NEW_LIMIT', time() - 30 * 24 * 60 * 60);
/**
......
<?php
// $Id$
/**
* @file
* Enables the creation of pages that can be added to the navigation system.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Enables the creation of pages that can be added to the navigation system.
*/
/**
* Implementation of hook_help().
*/
......
<?php
/* $Id$ */
/**
* @file
* Enables users to rename URLs.
*/
/**
* Implementation of hook_help().
*/
......
<?php
/* $Id$ */
/**
* @file
* Enables users to rename URLs.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Alerts other sites that your site has been updated.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Alerts other sites that your site has been updated.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Enables your site to capture votes on different topics in the form of multiple
* choice questions.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Enables your site to capture votes on different topics in the form of multiple
* choice questions.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Support for configurable user profiles.
*/
/**
* Flags to define the visibility of a profile field.
*/
......
<?php
// $Id$
/**
* @file
* Support for configurable user profiles.
*/
/**
* Flags to define the visibility of a profile field.
*/
......
<?php
// $Id$
/**
* @file
* Enables content to be moderated by the community.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Enables site-wide keyword searching.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Enables site-wide keyword searching.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Logs access statistics for your site.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Logs access statistics for your site.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Enables users to submit stories, articles or similar content.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Enables users to submit stories, articles or similar content.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Configuration system that lets administrators modify the workings of the site.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Configuration system that lets administrators modify the workings of the site.
*/
/**
* Implementation of hook_help().
*/
......
<?php
// $Id$
/**
* @file
* Enables the organization of content into categories.
*/
/**
* Implementation of hook_perm().
*/
......
<?php
// $Id$
/**
* @file
* Enables the organization of content into categories.
*/
/**
* Implementation of hook_perm().
*/
......
<?php
// $Id$
/**
* @file
* Allows configuration of congestion control auto-throttle mechanism.
*/
/**
* Determine the current load on the site.
*
......
<?php
// $Id$
/**
* @file
* Allows configuration of congestion control auto-throttle mechanism.
*/
/**
* Determine the current load on the site.
*
......
<?php
// $Id$
/**
* @file
* Enables tracking of recent posts for users.
*/
/**
* Implementation of hook_help().
*/
......