diff options
| author | Bharat Mediratta <bharat@menalto.com> | 2009-09-28 19:30:34 -0700 |
|---|---|---|
| committer | Bharat Mediratta <bharat@menalto.com> | 2009-09-28 19:30:34 -0700 |
| commit | a0a62a09922d855cd87d35ccc42ea7cf407a8df7 (patch) | |
| tree | e34be0ffd169fb9c1d9402f61a6e77e314d59059 | |
| parent | f9b351559c8ec826961fc17fc00c910133b4a43b (diff) | |
Do a pass on the gallery::find_file and Gallery_View::{script,css} PHPdoc.
| -rw-r--r-- | modules/gallery/helpers/gallery.php | 9 | ||||
| -rw-r--r-- | modules/gallery/libraries/Gallery_View.php | 12 |
2 files changed, 10 insertions, 11 deletions
diff --git a/modules/gallery/helpers/gallery.php b/modules/gallery/helpers/gallery.php index 033bf4bd..4b319484 100644 --- a/modules/gallery/helpers/gallery.php +++ b/modules/gallery/helpers/gallery.php @@ -80,15 +80,14 @@ class gallery_Core { } /** - * Provide a wrapper function for Kohana::find_file, that first strips the extension and - * then calls the Kohana::find_file supply that extension + * Provide a wrapper function for Kohana::find_file that first strips the extension and + * then calls the Kohana::find_file and supplies the extension as the type. * @param string directory to search in * @param string filename to look for * @param boolean file required (optional: default false) - * @param boolean make the file name relative (optiona: default false) - * @return array if the type is config, i18n or l10n + * @return array if the extension is config, i18n or l10n * @return string if the file is found (relative to the DOCROOT) - * @return FALSE if the file is not found + * @return false if the file is not found */ static function find_file($directory, $file, $required=false) { $file_name = substr($file, 0, -strlen($ext = strrchr($file, '.'))); diff --git a/modules/gallery/libraries/Gallery_View.php b/modules/gallery/libraries/Gallery_View.php index f3fa970b..253a314f 100644 --- a/modules/gallery/libraries/Gallery_View.php +++ b/modules/gallery/libraries/Gallery_View.php @@ -24,9 +24,9 @@ class Gallery_View_Core extends View { /** * Add a script to the combined scripts list. - * @param $file the file name or path of the script to include. if a path is specified then - * the location needs to be DOCROOT/lib. Just specifying a file name will result - * in searching the hierarchical file system. + * @param $file the file name or path of the script to include. If a path is specified then + * it needs to be relative to DOCROOT. Just specifying a file name will result + * in searching Kohana's cascading file system. */ public function script($file) { if (($path = gallery::find_file("js", $file, false))) { @@ -47,9 +47,9 @@ class Gallery_View_Core extends View { /** * Add a css file to the combined css list. - * @param $file the file name or path of a css file to include. if a path is specified then - * the location needs to be DOCROOT/lib. Just specifying a file name will result - * in searching the hierarchical file system. + * @param $file the file name or path of the script to include. If a path is specified then + * it needs to be relative to DOCROOT. Just specifying a file name will result + * in searching Kohana's cascading file system. */ public function css($file) { if (($path = gallery::find_file("css", $file, false))) { |