From: Matthias Schmidt <gravatronics@live.com>
Date: Wed, 6 Apr 2016 14:28:28 +0000 (+0200)
Subject: Add some missing method documentation
X-Git-Tag: 3.0.0_Beta_1~1967^2
X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=cbca4c6ec8583ea98ca3473a1966827e14f2fbfc;p=GitHub%2FWoltLab%2FWCF.git

Add some missing method documentation
---

diff --git a/wcfsetup/install/files/lib/data/box/Box.class.php b/wcfsetup/install/files/lib/data/box/Box.class.php
index 5e153aa984..84a9c8d725 100644
--- a/wcfsetup/install/files/lib/data/box/Box.class.php
+++ b/wcfsetup/install/files/lib/data/box/Box.class.php
@@ -217,6 +217,11 @@ class Box extends DatabaseObject {
 		// @todo
 	}
 	
+	/**
+	 * Returns the menu shown in the box.
+	 * 
+	 * @return	Menu
+	 */
 	public function getMenu() {
 		if ($this->menu === null) {
 			$this->menu = MenuCache::getInstance()->getMenuByID($this->menuID);
diff --git a/wcfsetup/install/files/lib/system/condition/TimeCondition.class.php b/wcfsetup/install/files/lib/system/condition/TimeCondition.class.php
index 5d8ec76e05..ce988158d7 100644
--- a/wcfsetup/install/files/lib/system/condition/TimeCondition.class.php
+++ b/wcfsetup/install/files/lib/system/condition/TimeCondition.class.php
@@ -95,6 +95,11 @@ class TimeCondition extends AbstractMultipleFieldsCondition implements IContentC
 HTML;
 	}
 	
+	/**
+	 * Returns the select element with all available timezones.
+	 * 
+	 * @return	string
+	 */
 	protected function getTimezoneFieldElement() {
 		$fieldElement = '<select name="timezone" id="timezone"><option value="0"'.($this->timezone ? ' selected="selected"' : '').'>'.WCF::getLanguage()->get('wcf.date.timezone.user').'</option>';
 		foreach (DateUtil::getAvailableTimezones() as $timezone) {
diff --git a/wcfsetup/install/files/lib/system/importer/AbstractAttachmentImporter.class.php b/wcfsetup/install/files/lib/system/importer/AbstractAttachmentImporter.class.php
index 802a702911..53735052db 100644
--- a/wcfsetup/install/files/lib/system/importer/AbstractAttachmentImporter.class.php
+++ b/wcfsetup/install/files/lib/system/importer/AbstractAttachmentImporter.class.php
@@ -69,7 +69,7 @@ class AbstractAttachmentImporter extends AbstractImporter {
 			if (!copy($additionalData['fileLocation'], $attachment->getLocation())) {
 				throw new SystemException();
 			}
-				
+			
 			return $attachment->attachmentID;
 		}
 		catch (SystemException $e) {
@@ -81,6 +81,14 @@ class AbstractAttachmentImporter extends AbstractImporter {
 		return 0;
 	}
 	
+	/**
+	 * Replaces old attachment BBCodes with BBCodes with the new attachment id.
+	 * 
+	 * @param	string		$message
+	 * @param	integer		$oldID
+	 * @param	integer		$newID
+	 * @return	string|boolean
+	 */
 	protected function fixEmbeddedAttachments($message, $oldID, $newID) {
 		if (mb_strripos($message, '[attach]'.$oldID.'[/attach]') !== false || mb_strripos($message, '[attach='.$oldID.']') !== false || mb_strripos($message, '[attach='.$oldID.',') !== false) {
 			$message = str_ireplace('[attach]'.$oldID.'[/attach]', '[attach]'.$newID.'[/attach]', $message);
diff --git a/wcfsetup/install/files/lib/util/Diff.class.php b/wcfsetup/install/files/lib/util/Diff.class.php
index f7a54d912d..df3451662f 100644
--- a/wcfsetup/install/files/lib/util/Diff.class.php
+++ b/wcfsetup/install/files/lib/util/Diff.class.php
@@ -62,6 +62,12 @@ class Diff {
 	 */
 	protected $d = null;
 	
+	/**
+	 * Creates a new instance of Diff.
+	 * 
+	 * @param	string[]	$a	original lines of text
+	 * @param	string[]	$b	modified lines of text
+	 */
 	public function __construct(array $a, array $b) {
 		$this->a = $a;
 		$this->b = $b;