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 5e153aa98446b32da6f6a9c61e221debd796c291..84a9c8d725c46f435e277fe45481ae2c1b7f65ad 100644 (file)
--- 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 5d8ec76e05cb27fcd3562ad3461daf4e804b65fe..ce988158d7dfcc313fd7c725837a83ccf6ec78f9 100644 (file)
--- 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 802a70291111ff7c48c1e665b7d92348f45cffe1..53735052dbd0d1a816eefd3ba38c825d972957e5 100644 (file)
--- 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 f7a54d912da7fec2248db9efa9eecc4ad20486b9..df3451662ffa573ebdabf1a8fe77fb7676f8a673 100644 (file)
--- 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;