Skip to content

Commit

Permalink
Issue #1317628 by Albert Volkman, Gaelan, disasm, mjonesdinero, xjm: …
Browse files Browse the repository at this point in the history
…Clean up API docs for include files n-z
  • Loading branch information
jhodgdon-drp committed Jan 16, 2013
1 parent cc65ed1 commit a03edeb
Show file tree
Hide file tree
Showing 10 changed files with 224 additions and 127 deletions.
2 changes: 1 addition & 1 deletion includes/password.inc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ function _password_itoa64() {
}

/**
* Encode bytes into printable base 64 using the *nix standard from crypt().
* Encodes bytes into printable base 64 using the *nix standard from crypt().
*
* @param $input
* The string containing bytes to encode.
Expand Down
12 changes: 6 additions & 6 deletions includes/path.inc
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ function drupal_path_alias_whitelist_rebuild($source = NULL) {
}

/**
* Fetch a specific URL alias from the database.
* Fetches a specific URL alias from the database.
*
* @param $conditions
* A string representing the source, a number representing the pid, or an
Expand Down Expand Up @@ -475,11 +475,11 @@ function path_delete($criteria) {
}

/**
* Determine whether a path is in the administrative section of the site.
* Determines whether a path is in the administrative section of the site.
*
* By default, paths are considered to be non-administrative. If a path does not
* match any of the patterns in path_get_admin_paths(), or if it matches both
* administrative and non-administrative patterns, it is considered
* By default, paths are considered to be non-administrative. If a path does
* not match any of the patterns in path_get_admin_paths(), or if it matches
* both administrative and non-administrative patterns, it is considered
* non-administrative.
*
* @param $path
Expand All @@ -503,7 +503,7 @@ function path_is_admin($path) {
}

/**
* Get a list of administrative and non-administrative paths.
* Gets a list of administrative and non-administrative paths.
*
* @return array
* An associative array containing the following keys:
Expand Down
2 changes: 1 addition & 1 deletion includes/session.inc
Original file line number Diff line number Diff line change
Expand Up @@ -274,7 +274,7 @@ function drupal_session_initialize() {
}

/**
* Forcefully starts a session, preserving already set session data.
* Starts a session forcefully, preserving already set session data.
*
* @ingroup php_wrappers
*/
Expand Down
16 changes: 10 additions & 6 deletions includes/tablesort.inc
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ class TableSort extends SelectQueryExtender {
}

/**
* Initialize the table sort context.
* Initializes the table sort context.
*/
protected function init() {
$ts = $this->order();
Expand Down Expand Up @@ -115,7 +115,7 @@ function tablesort_init($header) {
}

/**
* Format a column header.
* Formats a column header.
*
* If the cell in question is the column header for the current sort criterion,
* it gets special formatting. All possible sort criteria become links.
Expand All @@ -126,6 +126,7 @@ function tablesort_init($header) {
* An array of column headers in the format described in theme_table().
* @param $ts
* The current table sort context as returned from tablesort_init().
*
* @return
* A properly formatted cell, ready for _theme_table_cell().
*/
Expand All @@ -151,7 +152,7 @@ function tablesort_header($cell, $header, $ts) {
}

/**
* Format a table cell.
* Formats a table cell.
*
* Adds a class attribute to all cells in the currently active column.
*
Expand All @@ -163,6 +164,7 @@ function tablesort_header($cell, $header, $ts) {
* The current table sort context as returned from tablesort_init().
* @param $i
* The index of the cell's table column.
*
* @return
* A properly formatted cell, ready for _theme_table_cell().
*/
Expand All @@ -179,7 +181,7 @@ function tablesort_cell($cell, $header, $ts, $i) {
}

/**
* Compose a URL query parameter array for table sorting links.
* Composes a URL query parameter array for table sorting links.
*
* @return
* A URL query parameter array that consists of all components of the current
Expand All @@ -190,10 +192,11 @@ function tablesort_get_query_parameters() {
}

/**
* Determine the current sort criterion.
* Determines the current sort criterion.
*
* @param $headers
* An array of column headers in the format described in theme_table().
*
* @return
* An associative array describing the criterion, containing the keys:
* - "name": The localized title of the table column.
Expand Down Expand Up @@ -226,10 +229,11 @@ function tablesort_get_order($headers) {
}

/**
* Determine the current sort direction.
* Determines the current sort direction.
*
* @param $headers
* An array of column headers in the format described in theme_table().
*
* @return
* The current sort direction ("asc" or "desc").
*/
Expand Down
Loading

0 comments on commit a03edeb

Please sign in to comment.