From a8ddcd0cf3cdfad617720f268de2f281f966d815 Mon Sep 17 00:00:00 2001 From: Jimmy Berry Date: Thu, 23 Jun 2011 23:04:36 -0500 Subject: Patch #1198524: Initial docblock cleanup. --- geshifilter.admin.inc | 28 ++++++++++++++-------------- geshifilter.inc | 7 ++++--- geshifilter.install | 4 ++-- geshifilter.module | 18 +++++++++--------- geshifilter.pages.inc | 14 +++++++------- 5 files changed, 36 insertions(+), 35 deletions(-) diff --git a/geshifilter.admin.inc b/geshifilter.admin.inc index 37a48ee..d52c4bd 100644 --- a/geshifilter.admin.inc +++ b/geshifilter.admin.inc @@ -226,7 +226,7 @@ function geshifilter_admin_general_settings($form, &$form_state) { } /** - * Validate function for admin settings + * Validate function for admin settings. */ function geshifilter_admin_general_settings_validate($form, &$form_state) { // Check if automatically managed style sheet is posible @@ -236,7 +236,7 @@ function geshifilter_admin_general_settings_validate($form, &$form_state) { } /** - * Submit function for admin settings + * Submit function for admin settings. */ function geshifilter_admin_general_settings_submit($form, &$form_state) { // Regenerate language_css @@ -251,7 +251,7 @@ function geshifilter_admin_general_settings_submit($form, &$form_state) { } /** - * Menu callback for per language settings + * Menu callback for per language settings. */ function geshifilter_admin_per_language_settings($form_state, $view = 'enabled') { $form = array(); @@ -276,7 +276,7 @@ function geshifilter_admin_per_language_settings($form_state, $view = 'enabled') } /** - * Validate function for per language settings + * Validate function for per language settings. * * Check that language tags differ between languages and fro the generic tags. */ @@ -336,7 +336,7 @@ function geshifilter_per_language_settings_validate($form, &$form_state) { } /** - * Submit function for per language settings + * Submit function for per language settings. */ function geshifilter_admin_per_language_settings_submit($form, &$form_state) { // regenerate language_css @@ -347,9 +347,9 @@ function geshifilter_admin_per_language_settings_submit($form, &$form_state) { } /** - * Helper function for some settings form fields usable as general and specific settings + * Helper function for some settings form fields usable as general and specific settings. * - * @param stdClass $format format object (e.g. with field $format->format) + * @param stdClass $format format object (e.g. with field $format->format). */ function _geshifilter_general_highlight_tags_settings($format = NULL) { $form = array(); @@ -383,7 +383,7 @@ function _geshifilter_general_highlight_tags_settings($format = NULL) { } /** - * function for generating a form table for per language settings + * Function for generating a form table for per language settings. */ function geshifilter_per_language_settings($format, $view, $add_checkbox, $add_tag_option) { $form = array( @@ -443,7 +443,7 @@ function geshifilter_per_language_settings($format, $view, $add_checkbox, $add_t } /** - * theming function for the per language settings table + * Theming function for the per language settings table. */ function theme_geshifilter_per_language_settings($variables) { $form = $variables['form']; @@ -475,7 +475,7 @@ function theme_geshifilter_per_language_settings($variables) { } /** - * Helper function for flushing the GeSHi language definition cache + * Helper function for flushing the GeSHi language definition cache. */ function _geshifilter_flush_language_definition_cache() { if (GESHIFILTER_CSS_CLASSES_AUTOMATIC == variable_get('geshifilter_css_mode', GESHIFILTER_CSS_INLINE)) { @@ -488,7 +488,7 @@ function _geshifilter_flush_language_definition_cache() { } /** - * Helper function for clearing the appropriate filter cache entries + * Helper function for clearing the appropriate filter cache entries. */ function _geshifilter_clear_filter_cache() { $message = FALSE; @@ -516,9 +516,9 @@ function _geshifilter_clear_filter_cache() { } /** - * Helper function for generating the CSS rules + * Helper function for generating the CSS rules. * - * @return string with the CSS rules + * @return string with the CSS rules. */ function _geshifilter_generate_languages_css_rules() { $output = ''; @@ -545,7 +545,7 @@ function _geshifilter_generate_languages_css_rules() { /** * Function for generating the external stylesheet. * - * @param $force force the regeneration of the CSS file + * @param $force force the regeneration of the CSS file. */ function _geshifilter_generate_languages_css_file($force=FALSE) { $languages = _geshifilter_get_enabled_languages(); diff --git a/geshifilter.inc b/geshifilter.inc index c3b1c96..ac9043e 100644 --- a/geshifilter.inc +++ b/geshifilter.inc @@ -7,7 +7,8 @@ /** * List of available languages. - * @return an array mapping language code to array with the language path and full language name + * + * @return an array mapping language code to array with the language path and full language name. */ function _geshifilter_get_available_languages() { // try to get it from cache (database actually) @@ -59,7 +60,7 @@ function _geshifilter_get_enabled_languages() { } /** - * Helper function for gettings the tags + * Helper function for gettings the tags. * (with caching) */ function _geshifilter_get_tags($format) { @@ -82,7 +83,7 @@ function _geshifilter_get_tags($format) { } /** - * helper function for generating a GeSHi object + * Helper function for generating a GeSHi object. * @param $language the language to generate a GeSHi object for */ function _geshifilter_geshi_factory($source_code, $language) { diff --git a/geshifilter.install b/geshifilter.install index 3b582ae..a9267a3 100644 --- a/geshifilter.install +++ b/geshifilter.install @@ -6,7 +6,7 @@ */ /** - * Implementation of hook_install + * Implements hook_install(). */ function geshifilter_install() { // Enable some popular languages and set their language tags by default @@ -23,7 +23,7 @@ function geshifilter_install() { } /** - * On uninstall: remove module variables and clear variable cache + * On uninstall: remove module variables and clear variable cache. */ function geshifilter_uninstall() { db_query("DELETE FROM {variable} WHERE name LIKE 'geshifilter_%'"); diff --git a/geshifilter.module b/geshifilter.module index 7d1375e..8445d53 100644 --- a/geshifilter.module +++ b/geshifilter.module @@ -36,7 +36,7 @@ define('GESHIFILTER_LINE_NUMBERS_DEFAULT_FANCY10', 10); define('GESHIFILTER_LINE_NUMBERS_DEFAULT_FANCY20', 20); /** - * Implementation of hook_help(). + * Implements hook_help(). */ function geshifilter_help($path, $arg) { switch ($path) { @@ -72,7 +72,7 @@ function geshifilter_help($path, $arg) { } /** - * Implementation of hook_menu(). + * Implements hook_menu(). */ function geshifilter_menu() { $items = array(); @@ -145,7 +145,7 @@ function geshifilter_menu() { /** - * Implementation of hook_init(). + * Implements hook_init(). */ function geshifilter_init() { // Since the filtered content is cached, it is not possible to know on which @@ -210,7 +210,7 @@ function geshifilter_filter_settings_callback($form, &$form_state, $filter, $for } /** - * Implementation of hook_theme(). + * Implements hook_theme(). */ function geshifilter_theme() { return array( @@ -221,7 +221,7 @@ function geshifilter_theme() { } /** - * Implementation of hook_requirements(). + * Implements hook_requirements(). */ function geshifilter_requirements($phase) { $requirements = array(); @@ -279,7 +279,7 @@ function geshifilter_requirements($phase) { } /** - * Implements hook_libraries_info() + * Implements hook_libraries_info(). */ function geshifilter_libraries_info() { return array( @@ -302,9 +302,9 @@ function geshifilter_libraries_info() { } /** - * Helper function for checking if an automatically managed style sheet is possible + * Helper function for checking if an automatically managed style sheet is possible. * - * @return boolean indicating if an automatically managed style sheet is possible + * @return boolean indicating if an automatically managed style sheet is possible. */ function _geshifilter_managed_external_stylesheet_possible() { $directory = _geshifilter_language_css_path(TRUE); @@ -312,7 +312,7 @@ function _geshifilter_managed_external_stylesheet_possible() { } /** - * Callback function for generating the CSS rules for the syntax highlighting + * Callback function for generating the CSS rules for the syntax highlighting. */ function geshifilter_generate_language_css_rules() { require_once drupal_get_path('module', 'geshifilter') .'/geshifilter.admin.inc'; diff --git a/geshifilter.pages.inc b/geshifilter.pages.inc index 1b7a935..dd76758 100644 --- a/geshifilter.pages.inc +++ b/geshifilter.pages.inc @@ -12,11 +12,11 @@ require_once drupal_get_path('module', 'geshifilter') .'/geshifilter.inc'; /** - * Helper function for parsing the attributes of GeSHi code tags + * Helper function for parsing the attributes of GeSHi code tags. * to get the settings for language, line numbers, etc. * - * @param $attributes string with the attributes - * @param $format the concerning text format + * @param $attributes string with the attributes. + * @param $format the concerning text format. * @return array of settings with fields 'language', 'line_numbering', 'linenumbers_start' and 'title'. */ function _geshifilter_parse_attributes($attributes, $format) { @@ -198,7 +198,7 @@ function _geshifilter_prepare_callback($match, $format) { } /** - * _geshifilter_prepare callback for < ?php ... ? > blocks + * _geshifilter_prepare callback for < ?php ... ? > blocks. */ function _geshifilter_prepare_php_callback($match) { return '[geshifilter-questionmarkphp]' @@ -234,7 +234,7 @@ function _geshifilter_process($format, $text) { /** - * preg_replace_callback callback + * preg_replace_callback callback. */ function _geshifilter_replace_callback($match, $format) { // $match[0]: complete matched string @@ -294,7 +294,7 @@ function _geshifilter_replace_callback($match, $format) { } /** - * Helper function for overriding some GeSHi defaults + * Helper function for overriding some GeSHi defaults. */ function _geshifilter_override_geshi_defaults(&$geshi, $langcode) { // override the some default GeSHi styles (e.g. GeSHi uses Courier by default, which is ugly) @@ -392,7 +392,7 @@ function geshifilter_geshi_process($source_code, $lang, $line_numbering=0, $line } /** - * geshifilter wrapper for highlight_string() processing of PHP + * geshifilter wrapper for highlight_string() processing of PHP. */ function geshifilter_highlight_string_process($source_code, $inline_mode) { // Make sure that the source code starts with < ?php and ends with ? > -- 1.7.5.4