diff --git a/theme/nimble/layout/frontpage.php b/theme/nimble/layout/frontpage.php index a91780940fc..430204a2dbf 100644 --- a/theme/nimble/layout/frontpage.php +++ b/theme/nimble/layout/frontpage.php @@ -1,4 +1,26 @@ . + +/** + * The frontpage layout. + * + * @package theme_nimble + * @copyright 2010 Patrick Malley + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ $hasheading = ($PAGE->heading); $hasnavbar = (empty($PAGE->layout_options['nonavbar']) && $PAGE->has_navbar()); diff --git a/theme/nimble/layout/general.php b/theme/nimble/layout/general.php index 13b33bdcacf..d94902adeb7 100644 --- a/theme/nimble/layout/general.php +++ b/theme/nimble/layout/general.php @@ -1,4 +1,26 @@ . + +/** + * The default layout. + * + * @package theme_nimble + * @copyright 2010 Patrick Malley + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ $hasheading = ($PAGE->heading); $hasnavbar = (empty($PAGE->layout_options['nonavbar']) && $PAGE->has_navbar()); diff --git a/theme/nimble/lib.php b/theme/nimble/lib.php index bcbbda8a5c4..3f98ab0915d 100644 --- a/theme/nimble/lib.php +++ b/theme/nimble/lib.php @@ -1,4 +1,26 @@ . + +/** + * This file contains functions specific to the needs of the Nimble theme. + * + * @package theme_nimble + * @copyright 2010 Patrick Malley + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ /** * Makes our changes to the CSS @@ -9,7 +31,7 @@ */ function nimble_process_css($css, $theme) { - // Set the link color + // Set the link color. if (!empty($theme->settings->linkcolor)) { $linkcolor = $theme->settings->linkcolor; } else { @@ -17,33 +39,32 @@ function nimble_process_css($css, $theme) { } $css = nimble_set_linkcolor($css, $linkcolor); - // Set the link hover color + // Set the link hover color. if (!empty($theme->settings->linkhover)) { $linkhover = $theme->settings->linkhover; } else { $linkhover = null; } $css = nimble_set_linkhover($css, $linkhover); - - - // Set the background color + + // Set the background color. if (!empty($theme->settings->backgroundcolor)) { $backgroundcolor = $theme->settings->backgroundcolor; } else { $backgroundcolor = null; } $css = nimble_set_backgroundcolor($css, $backgroundcolor); - - - - // Return the CSS + // Return the CSS. return $css; } /** * Sets the link color variable in CSS * + * @param string $css + * @param string $linkcolor + * @return string */ function nimble_set_linkcolor($css, $linkcolor) { $tag = '[[setting:linkcolor]]'; @@ -55,6 +76,13 @@ function nimble_set_linkcolor($css, $linkcolor) { return $css; } +/** + * Sets the link hover colour in CSS. + * + * @param string $css + * @param string $linkhover + * @return string + */ function nimble_set_linkhover($css, $linkhover) { $tag = '[[setting:linkhover]]'; $replacement = $linkhover; @@ -65,7 +93,12 @@ function nimble_set_linkhover($css, $linkhover) { return $css; } - +/** + * Sets the background colour in CSS. + * @param string $css + * @param string $backgroundcolor + * @return string + */ function nimble_set_backgroundcolor($css, $backgroundcolor) { $tag = '[[setting:backgroundcolor]]'; $replacement = $backgroundcolor; @@ -74,5 +107,4 @@ function nimble_set_backgroundcolor($css, $backgroundcolor) { } $css = str_replace($tag, $replacement, $css); return $css; -} - +} \ No newline at end of file diff --git a/theme/nimble/settings.php b/theme/nimble/settings.php index a8a233f3cd8..70840bcf84c 100644 --- a/theme/nimble/settings.php +++ b/theme/nimble/settings.php @@ -1,4 +1,26 @@ . + +/** + * Settings for the Nimble theme. + * + * @package theme_nimble + * @copyright 2010 Patrick Malley + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ defined('MOODLE_INTERNAL') || die;