summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSebastian Siemssen2012-12-23 14:09:02 (GMT)
committer Sebastian Siemssen2012-12-23 14:09:02 (GMT)
commit41a4130d6005cd982818335fe6f101baa3bee3ae (patch)
treecb938724a97ea41612dac64a2d9f065d23f73e2a
parentf4ccc995ea411bcf68c254bd80bfe0ef34ea1aa6 (diff)
Documentation fixes for omega.drush.inc
-rw-r--r--includes/omega.drush.inc14
1 files changed, 8 insertions, 6 deletions
diff --git a/includes/omega.drush.inc b/includes/omega.drush.inc
index 880d335..e31c137 100644
--- a/includes/omega.drush.inc
+++ b/includes/omega.drush.inc
@@ -164,7 +164,7 @@ function drush_omega_subtheme($name = NULL) {
* Resolves the destination path for a subtheme. This can either be a profile
* theme folder, a sites theme folder or a theme.
*
- * @param string $destination
+ * @param $destination
* A destination string, this can either be a site path ('sites/foo'), a
* profile path ('profiles/foo') or a theme path ('themes/foo').
*
@@ -215,8 +215,10 @@ function drush_omega_export_validate($theme = NULL) {
* Exports the theme settings for the given theme from the database and writes
* them into the .info file of that theme.
*
- * @param $name
- * The machine-readable name of a theme.
+ * @param $theme
+ * (optional) The machine-readable name of a theme.
+ * @return bool
+ * TRUE on success, FALSE on failure.
*/
function drush_omega_export($theme = NULL) {
if (!isset($theme) && !$theme = _omega_drush_theme_choice()) {
@@ -283,7 +285,7 @@ function drush_omega_revert_validate($theme) {
* Delete the theme settings that have been stored in the database and thereby
* reverts them to the default settings from the .info file.
*
- * @param $name
+ * @param $theme
* The machine-readable name of a theme.
*/
function drush_omega_revert($theme = NULL) {
@@ -556,7 +558,7 @@ function omega_drush_subtheme_create($subtheme) {
/**
* Retrieve an array of available sites from the sites.php.
*
- * @return
+ * @return array
* An array that contains all the available sites in a multisite environment.
*/
function omega_drush_sites() {
@@ -576,7 +578,7 @@ function omega_drush_sites() {
* Helper function for generating a valid machine-readable name for a theme from
* any string.
*
- * @param $name
+ * @param $string
* The string to generate the machine-readable name from.
*
* @return string