From 7f47cc062c3bddd788bfc6dbbe720ec55cc2f3bf Mon Sep 17 00:00:00 2001
From: Morris Jobke <morris.jobke@gmail.com>
Date: Mon, 25 Nov 2013 14:12:07 +0100
Subject: fix defaults.php doc

---
 lib/private/defaults.php | 50 ++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 44 insertions(+), 6 deletions(-)

(limited to 'lib')

diff --git a/lib/private/defaults.php b/lib/private/defaults.php
index 4951c6f50ae..cec9a65c7f3 100644
--- a/lib/private/defaults.php
+++ b/lib/private/defaults.php
@@ -1,15 +1,13 @@
 <?php
 
-/**
- * Default strings and values which differ between the enterprise and the
- * community edition. Use the get methods to always get the right strings.
- */
-
-
 if (file_exists(OC::$SERVERROOT . '/themes/' . OC_Util::getTheme() . '/defaults.php')) {
 	require_once 'themes/' . OC_Util::getTheme() . '/defaults.php';
 }
 
+/**
+ * Default strings and values which differ between the enterprise and the
+ * community edition. Use the get methods to always get the right strings.
+ */
 class OC_Defaults {
 
 	private $theme;
@@ -48,6 +46,10 @@ class OC_Defaults {
 		return false;
 	}
 
+	/**
+	 * Returns the base URL
+	 * @return string URL
+	 */
 	public function getBaseUrl() {
 		if ($this->themeExist('getBaseUrl')) {
 			return $this->theme->getBaseUrl();
@@ -56,6 +58,10 @@ class OC_Defaults {
 		}
 	}
 
+	/**
+	 * Returns the URL where the sync clients are listed
+	 * @return string URL
+	 */
 	public function getSyncClientUrl() {
 		if ($this->themeExist('getSyncClientUrl')) {
 			return $this->theme->getSyncClientUrl();
@@ -64,6 +70,10 @@ class OC_Defaults {
 		}
 	}
 
+	/**
+	 * Returns the documentation URL
+	 * @return string URL
+	 */
 	public function getDocBaseUrl() {
 		if ($this->themeExist('getDocBaseUrl')) {
 			return $this->theme->getDocBaseUrl();
@@ -72,6 +82,10 @@ class OC_Defaults {
 		}
 	}
 
+	/**
+	 * Returns the title
+	 * @return string title
+	 */
 	public function getTitle() {
 		if ($this->themeExist('getTitle')) {
 			return $this->theme->getTitle();
@@ -80,6 +94,10 @@ class OC_Defaults {
 		}
 	}
 
+	/**
+	 * Returns the short name of the software
+	 * @return string title
+	 */
 	public function getName() {
 		if ($this->themeExist('getName')) {
 			return $this->theme->getName();
@@ -88,6 +106,10 @@ class OC_Defaults {
 		}
 	}
 
+	/**
+	 * Returns entity (e.g. company name) - used for footer, copyright
+	 * @return string entity name
+	 */
 	public function getEntity() {
 		if ($this->themeExist('getEntity')) {
 			return $this->theme->getEntity();
@@ -96,6 +118,10 @@ class OC_Defaults {
 		}
 	}
 
+	/**
+	 * Returns slogan
+	 * @return string slogan
+	 */
 	public function getSlogan() {
 		if ($this->themeExist('getSlogan')) {
 			return $this->theme->getSlogan();
@@ -104,6 +130,10 @@ class OC_Defaults {
 		}
 	}
 
+	/**
+	 * Returns logo claim
+	 * @return string logo claim
+	 */
 	public function getLogoClaim() {
 		if ($this->themeExist('getLogoClaim')) {
 			return $this->theme->getLogoClaim();
@@ -112,6 +142,10 @@ class OC_Defaults {
 		}
 	}
 
+	/**
+	 * Returns short version of the footer
+	 * @return string short footer
+	 */
 	public function getShortFooter() {
 		if ($this->themeExist('getShortFooter')) {
 			$footer = $this->theme->getShortFooter();
@@ -123,6 +157,10 @@ class OC_Defaults {
 		return $footer;
 	}
 
+	/**
+	 * Returns long version of the footer
+	 * @return string long footer
+	 */
 	public function getLongFooter() {
 		if ($this->themeExist('getLongFooter')) {
 			$footer = $this->theme->getLongFooter();
-- 
cgit v1.2.3