Add missing parameter documentation
authorMatthias Schmidt <gravatronics@live.com>
Sat, 21 May 2016 12:55:57 +0000 (14:55 +0200)
committerMatthias Schmidt <gravatronics@live.com>
Sat, 21 May 2016 12:55:57 +0000 (14:55 +0200)
files/lib/data/conversation/ConversationParticipantList.class.php
files/lib/system/page/handler/TConversationOnlineLocationPageHandler.class.php

index 005dfdea5bf80febf088e277867cc9514ffa9fc2..3f4b522e52d25ce7c137b0558510c0fffe5ab022 100644 (file)
@@ -30,6 +30,7 @@ class ConversationParticipantList extends UserProfileList {
         * Creates a new ConversationParticipantList object.
         * 
         * @param       integer         $conversationID
+        * @param       integer         $userID
         * @param       boolean         $isAuthor               true if given user is the author of this conversation
         */
        public function __construct($conversationID, $userID = 0, $isAuthor = false) {
index 75373d416bc152e4cc93d6a99886712cd04663b5..a4149c7839824e6bb94817f8f9830fea1a360315 100644 (file)
@@ -20,7 +20,13 @@ trait TConversationOnlineLocationPageHandler {
        use TOnlineLocationPageHandler;
        
        /**
-        * @see IMenuPageHandler::getOnlineLocation()
+        * Returns the textual description if a user is currently online viewing this page.
+        *
+        * @see IOnlineLocationPageHandler::getOnlineLocation()
+        *
+        * @param       Page            $page           visited page
+        * @param       UserOnline      $user           user online object with request data
+        * @return      string
         */
        public function getOnlineLocation(Page $page, UserOnline $user) {
                if ($user->objectID === null) {
@@ -36,7 +42,13 @@ trait TConversationOnlineLocationPageHandler {
        }
        
        /**
+        * Prepares fetching all necessary data for the textual description if a user is currently online
+        * viewing this page.
+        *
         * @see IOnlineLocationPageHandler::prepareOnlineLocation()
+        *
+        * @param       Page            $page           visited page
+        * @param       UserOnline      $user           user online object with request data
         */
        public function prepareOnlineLocation(Page $page, UserOnline $user) {
                if ($user->objectID !== null) {