From 2148998600ea14997110d909cd3abd95f7793621 Mon Sep 17 00:00:00 2001
From: Matthias Schmidt <gravatronics@live.com>
Date: Thu, 28 Jul 2011 09:43:27 +0200
Subject: [PATCH] Updated form and page documentations

Updated the form and page documentations, some acp forms' documentations
still need to be updated. Additionally the obsolete property
wcf\acp\page\PackageListPage::$packageList has been removed and a
property name typo was fixed (in wcf\acp\form\PackageUpdateAuthForm:
$header instead of $eader).
---
 .../files/lib/acp/form/ACPForm.class.php      |  3 +-
 .../acp/form/AbstractOptionListForm.class.php |  4 +-
 .../lib/acp/form/CronjobEditForm.class.php    |  4 +-
 .../files/lib/acp/form/LoginForm.class.php    |  2 +-
 .../lib/acp/form/MasterPasswordForm.class.php |  2 -
 .../acp/form/MasterPasswordInitForm.class.php |  1 -
 .../lib/acp/form/OptionImportForm.class.php   |  8 +--
 .../form/PackageStartInstallForm.class.php    | 38 +++++++++-
 .../acp/form/PackageUpdateAuthForm.class.php  | 72 ++++++++++++++++++-
 .../lib/acp/form/PackageUpdateForm.class.php  | 30 ++++++++
 .../form/PackageUpdateSearchForm.class.php    | 60 ++++++++++++++++
 .../acp/form/UserAssignToGroupForm.class.php  | 13 +++-
 .../lib/acp/page/ACPSessionLogPage.class.php  |  2 -
 .../lib/acp/page/CacheListPage.class.php      | 15 +++-
 .../files/lib/acp/page/IndexPage.class.php    |  4 +-
 .../page/PackageAutoUpdateListPage.class.php  | 11 +++
 .../lib/acp/page/PackageListPage.class.php    | 29 +++++---
 .../PackageUpdateSearchResultPage.class.php   | 22 +++++-
 .../lib/acp/page/PackageViewPage.class.php    | 37 +++++++++-
 .../acp/page/UpdateServerListPage.class.php   | 19 ++++-
 .../lib/acp/page/UserGroupListPage.class.php  | 21 +++++-
 .../files/lib/acp/page/UserListPage.class.php | 25 +++++--
 .../files/lib/form/AbstractForm.class.php     |  6 +-
 .../files/lib/page/AbstractPage.class.php     | 12 ++--
 .../files/lib/page/MultipleLinkPage.class.php | 21 ++----
 .../files/lib/page/SortablePage.class.php     | 12 ++--
 26 files changed, 391 insertions(+), 82 deletions(-)

diff --git a/wcfsetup/install/files/lib/acp/form/ACPForm.class.php b/wcfsetup/install/files/lib/acp/form/ACPForm.class.php
index 129258d54a..7562e345e8 100755
--- a/wcfsetup/install/files/lib/acp/form/ACPForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/ACPForm.class.php
@@ -15,8 +15,7 @@ use wcf\form\AbstractForm;
  */
 class ACPForm extends AbstractForm {
 	/**
-	 * Active acp menu item.
-	 * 
+	 * active acp menu item
 	 * @var string
 	 */
 	public $activeMenuItem = '';
diff --git a/wcfsetup/install/files/lib/acp/form/AbstractOptionListForm.class.php b/wcfsetup/install/files/lib/acp/form/AbstractOptionListForm.class.php
index 0412674061..324f18c495 100755
--- a/wcfsetup/install/files/lib/acp/form/AbstractOptionListForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/AbstractOptionListForm.class.php
@@ -42,13 +42,13 @@ abstract class AbstractOptionListForm extends AbstractForm {
 
 	/**
 	 * list of all option categories
-	 * @var array<OptionCategory>
+	 * @var array<wcf\data\option\category\OptionCategory>
 	 */
 	public $cachedCategories = array();
 	
 	/**
 	 * list of all options
-	 * @var array<Option>
+	 * @var array<wcf\data\option\Option>
 	 */
 	public $cachedOptions = array();
 	
diff --git a/wcfsetup/install/files/lib/acp/form/CronjobEditForm.class.php b/wcfsetup/install/files/lib/acp/form/CronjobEditForm.class.php
index ce5de5f477..b1b3df0272 100755
--- a/wcfsetup/install/files/lib/acp/form/CronjobEditForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/CronjobEditForm.class.php
@@ -28,15 +28,13 @@ class CronjobEditForm extends CronjobAddForm {
 	
 	/**
 	 * cronjob id
-	 * 
 	 * @var	integer
 	 */
 	public $cronjobID = 0;
 	
 	/**
 	 * cronjob object
-	 *
-	 * @var Cronjob
+	 * @var wcf\data\cronjob\Cronjob
 	 */
 	public $cronjob = null;
 	
diff --git a/wcfsetup/install/files/lib/acp/form/LoginForm.class.php b/wcfsetup/install/files/lib/acp/form/LoginForm.class.php
index 7eabecce4a..075968cfbf 100755
--- a/wcfsetup/install/files/lib/acp/form/LoginForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/LoginForm.class.php
@@ -39,7 +39,7 @@ class LoginForm extends AbstractForm {
 	
 	/**
 	 * user object
-	 * @var User
+	 * @var wcf\data\user\User
 	 */
 	public $user;
 	
diff --git a/wcfsetup/install/files/lib/acp/form/MasterPasswordForm.class.php b/wcfsetup/install/files/lib/acp/form/MasterPasswordForm.class.php
index cdcf790db7..b5d0b3b23d 100755
--- a/wcfsetup/install/files/lib/acp/form/MasterPasswordForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/MasterPasswordForm.class.php
@@ -23,14 +23,12 @@ class MasterPasswordForm extends ACPForm {
 	
 	/**
 	 * master password
-	 *
 	 * @var string
 	 */
 	public $masterPassword = '';
 	
 	/**
 	 * forward url
-	 *
 	 * @var string
 	 */
 	public $url = '';
diff --git a/wcfsetup/install/files/lib/acp/form/MasterPasswordInitForm.class.php b/wcfsetup/install/files/lib/acp/form/MasterPasswordInitForm.class.php
index db330d113d..9f1445420b 100755
--- a/wcfsetup/install/files/lib/acp/form/MasterPasswordInitForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/MasterPasswordInitForm.class.php
@@ -25,7 +25,6 @@ class MasterPasswordInitForm extends MasterPasswordForm {
 
 	/**
 	 * master password confirm
-	 * 
 	 * @var	string
 	 */
 	public $confirmMasterPassword = '';
diff --git a/wcfsetup/install/files/lib/acp/form/OptionImportForm.class.php b/wcfsetup/install/files/lib/acp/form/OptionImportForm.class.php
index 2101b64719..0e32533106 100755
--- a/wcfsetup/install/files/lib/acp/form/OptionImportForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/OptionImportForm.class.php
@@ -23,14 +23,14 @@ class OptionImportForm extends ACPForm {
 	public $templateName = 'optionImport';
 	
 	/**
-	 * @see wcf\acp\form\ACPForm::$activeMenuItem
+	 * @see wcf\page\AbstractPage::$neededPermissions
 	 */
-	public $activeMenuItem = 'wcf.acp.menu.link.option.importAndExport';
+	public $neededPermissions = array('admin.system.canEditOption');
 	
 	/**
-	 * @see wcf\page\AbstractPage::$neededPermissions
+	 * @see wcf\acp\form\ACPForm::$activeMenuItem
 	 */
-	public $neededPermissions = array('admin.system.canEditOption');
+	public $activeMenuItem = 'wcf.acp.menu.link.option.importAndExport';
 	
 	/**
 	 * upload file data
diff --git a/wcfsetup/install/files/lib/acp/form/PackageStartInstallForm.class.php b/wcfsetup/install/files/lib/acp/form/PackageStartInstallForm.class.php
index 13ddfe9bf2..63e3309ce6 100755
--- a/wcfsetup/install/files/lib/acp/form/PackageStartInstallForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/PackageStartInstallForm.class.php
@@ -25,14 +25,50 @@ use wcf\util\StringUtil;
  * @category 	Community Framework
  */
 class PackageStartInstallForm extends ACPForm {
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'packageStartInstall';
+	
+	/**
+	 * @see wcf\acp\form\ACPForm::$activeMenuItem
+	 */
 	public $activeMenuItem = 'wcf.acp.menu.link.package.install';
-		
+	
+	/**
+	 * id of the updated package
+	 * @var	integer
+	 */
 	public $packageID = 0;
+	
+	/**
+	 * updated package object
+	 * @var	wcf\system\package\Package
+	 */
 	public $package = null;
+	
+	/**
+	 * url to the package to download
+	 * @var	string
+	 */
 	public $downloadPackage = '';
+	
+	/**
+	 * data of the uploaded package
+	 * @var	array<string>
+	 */
 	public $uploadPackage = '';
+	
+	/**
+	 * archive of the instalation/update package
+	 * @var	wcf\system\package\PackageArchive
+	 */
 	public $archive = null;
+	
+	/**
+	 * package installation/update queue
+	 * @var	wcf\data\package\installation\queue\PackageInstallationQueue
+	 */
 	public $queue = null;
 	
 	/**
diff --git a/wcfsetup/install/files/lib/acp/form/PackageUpdateAuthForm.class.php b/wcfsetup/install/files/lib/acp/form/PackageUpdateAuthForm.class.php
index 8034837773..41e95fe5cd 100755
--- a/wcfsetup/install/files/lib/acp/form/PackageUpdateAuthForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/PackageUpdateAuthForm.class.php
@@ -17,24 +17,92 @@ use wcf\util\StringUtil;
  * @category 	Community Framework
  */
 class PackageUpdateAuthForm extends ACPForm {
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'packageUpdateAuth';
+	
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canInstallPackage');
+	
+	/**
+	 * @see wcf\acp\form\ACPForm::$activeMenuItem
+	 */
 	public $activeMenuItem = 'wcf.acp.menu.link.package';
 	
-	public $exception;
+	/**
+	 * exception thrown if an authorization for the package update server is needed
+	 * @var	wcf\system\package\PackageUpdateAuthorizationRequiredException
+	 */
+	public $exception = null;
+	
+	/**
+	 * login username for package update server
+	 * @var	string
+	 */
 	public $loginUsername = '';
+	
+	/**
+	 * login password for package update server
+	 * @var	string
+	 */
 	public $loginPassword = '';
+	
+	/**
+	 * indicates if login data is saved
+	 * @var	integer
+	 */
 	public $saveAuthData = 0;
 	
+	/**
+	 * id of the relevant package update server
+	 * @var	integer
+	 */
 	public $packageUpdateServerID = 0;
+	
+	/**
+	 * url of the relevant package update server
+	 * @var	integer
+	 */
 	public $url = '';
-	public $eader = '';
+	
+	/**
+	 * response header of the relavent package update server
+	 * @var	string
+	 */
+	public $header = '';
+	
+	/**
+	 * realm part of the response header
+	 * @var	string
+	 */
 	public $realm = '';
+	
+	/**
+	 * response of the relevant package update server
+	 * @var	integer
+	 */
 	public $message = '';
 	
+	/**
+	 * post parameters of the form
+	 * @var	string
+	 */
 	public $postParameters = '';
+	
+	/**
+	 * get parameters of the form
+	 * @var	string
+	 */
 	public $getParameters = '';
 	
+	/**
+	 * list of reserved parameters that may not be part of the post and get
+	 * parameters
+	 * @var	array<string>
+	 */
 	protected static $reservedParameters = array('s', 'packageID', 'page', 'form', 'action', 'packageUpdateServerID', 'loginUsername', 'loginPassword', 'saveAuthData', 'requestedPage', 'requestedForm', 'requestedAction');
 	
 	/**
diff --git a/wcfsetup/install/files/lib/acp/form/PackageUpdateForm.class.php b/wcfsetup/install/files/lib/acp/form/PackageUpdateForm.class.php
index fa121143c2..4e12584ddb 100755
--- a/wcfsetup/install/files/lib/acp/form/PackageUpdateForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/PackageUpdateForm.class.php
@@ -18,13 +18,43 @@ use wcf\util\HeaderUtil;
  * @category 	Community Framework
  */
 class PackageUpdateForm extends ACPForm {
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'packageUpdate';
+	
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canInstallPackage');
+	
+	/**
+	 * @see wcf\acp\form\ACPForm::$activeMenuItem
+	 */
 	public $activeMenuItem = 'wcf.acp.menu.link.package';
 	
+	/**
+	 * list of packages to update
+	 * @var	array<string>
+	 */
 	public $updates = array();
+	
+	/**
+	 * list with data of excluded packages
+	 * @var	array<array>
+	 */
 	public $excludedPackages = array();
+	
+	/**
+	 * list with data of packages which will be installed
+	 * @var	array<array>
+	 */
 	public $packageInstallationStack = array();
+	
+	/**
+	 * scheduler for package update
+	 * @var	wcf\system\package\PackageInstallationScheduler
+	 */
 	public $packageUpdate = null;
 	
 	/**
diff --git a/wcfsetup/install/files/lib/acp/form/PackageUpdateSearchForm.class.php b/wcfsetup/install/files/lib/acp/form/PackageUpdateSearchForm.class.php
index 43b61ceed2..26515b92d2 100644
--- a/wcfsetup/install/files/lib/acp/form/PackageUpdateSearchForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/PackageUpdateSearchForm.class.php
@@ -22,20 +22,80 @@ use wcf\util\StringUtil;
  * @category 	Community Framework
  */
 class PackageUpdateSearchForm extends ACPForm {
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'packageUpdateSearch';
+	
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canInstallPackage');
+	
+	/**
+	 * @see wcf\acp\form\ACPForm::$activeMenuItem
+	 */
 	public $activeMenuItem = 'wcf.acp.menu.link.package.database';
 	
+	/**
+	 * list of package server ids which are searched
+	 * @var	array<integer>
+	 */
 	public $packageUpdateServerIDs = array();
+	
+	/**
+	 * searched package name
+	 * @var	string
+	 */
 	public $packageName = '';
+	
+	/**
+	 * searched author
+	 * @var	string
+	 */
 	public $author = '';
+	
+	/**
+	 * indicates if package description is searched
+	 * @var	integer
+	 */
 	public $searchDescription = 0;
+	
+	/**
+	 * indicates if plugins for already installed packages are searched
+	 * @var	integer
+	 */
 	public $plugin = 1;
+	
+	/**
+	 * indicates if standalone applications are searched
+	 * @var	integer
+	 */
 	public $standalone = 1;
+	
+	/**
+	 * indicates if packages that aren't plugins or standalone applications
+	 * are searched
+	 * @var	integer
+	 */
 	public $other = 0;
+	
+	/**
+	 * indicates if unique packages are ignored that are already installed
+	 * @var	integer
+	 */
 	public $ignoreUniques = 1;
 	
+	/**
+	 * list of available update servers
+	 * @var	array<wcf\data\package\update\server\PackageUpdateServer>
+	 */
 	public $updateServers = array();
+	
+	/**
+	 * ids of package updates
+	 * @var	string
+	 */
 	public $packageUpdateIDs = '';
 	
 	/**
diff --git a/wcfsetup/install/files/lib/acp/form/UserAssignToGroupForm.class.php b/wcfsetup/install/files/lib/acp/form/UserAssignToGroupForm.class.php
index 2f1ba5e2ba..bd9f2b2eea 100755
--- a/wcfsetup/install/files/lib/acp/form/UserAssignToGroupForm.class.php
+++ b/wcfsetup/install/files/lib/acp/form/UserAssignToGroupForm.class.php
@@ -21,10 +21,21 @@ use wcf\util\ArrayUtil;
  * @category 	Community Framework
  */
 class UserAssignToGroupForm extends ACPForm {
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'userAssignToGroup';
-	public $activeMenuItem = 'wcf.acp.menu.link.user.management';
+	
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.user.canEditUser');
 	
+	/**
+	 * @see wcf\acp\form\ACPForm::$activeMenuItem
+	 */
+	public $activeMenuItem = 'wcf.acp.menu.link.user.management';
+	
 	public $userIDs = array();
 	public $groupIDs = array();
 	public $users = array();
diff --git a/wcfsetup/install/files/lib/acp/page/ACPSessionLogPage.class.php b/wcfsetup/install/files/lib/acp/page/ACPSessionLogPage.class.php
index 113e504a45..96997e7a2a 100755
--- a/wcfsetup/install/files/lib/acp/page/ACPSessionLogPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/ACPSessionLogPage.class.php
@@ -34,14 +34,12 @@ class ACPSessionLogPage extends SortablePage {
 	
 	/**
 	 * session log id
-	 *
 	 * @var integer
 	 */
 	public $sessionLogID = 0;
 	
 	/**
 	 * session log object
-	 *
 	 * @var wcf\data\acp\session\log\ACPSessionLog
 	 */
 	public $sessionLog = null;
diff --git a/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php b/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php
index 704fc6d235..42ff8e5bcd 100755
--- a/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/CacheListPage.class.php
@@ -20,21 +20,30 @@ use wcf\util\FileUtil;
  * @category 	Community Framework
  */
 class CacheListPage extends AbstractPage {
-	// system
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'cacheList';
+	
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.system.canViewLog');
+	
+	/**
+	 * indicates if cache was cleared
+	 * @var	integer
+	 */
 	public $cleared = 0;
 	
 	/**
 	 * contains a list of cache resources
-	 *
 	 * @var	array
 	 */
 	public $caches = array();
 	
 	/**
 	 * contains general cache information
-	 *
 	 * @var array
 	 */
 	public $cacheData = array();
diff --git a/wcfsetup/install/files/lib/acp/page/IndexPage.class.php b/wcfsetup/install/files/lib/acp/page/IndexPage.class.php
index fc319b70ce..e3dc9420b4 100755
--- a/wcfsetup/install/files/lib/acp/page/IndexPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/IndexPage.class.php
@@ -17,7 +17,9 @@ use wcf\system\WCFACP;
  * @category 	Community Framework
  */
 class IndexPage extends AbstractPage {
-	// system
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'index';
 	
 	/**
diff --git a/wcfsetup/install/files/lib/acp/page/PackageAutoUpdateListPage.class.php b/wcfsetup/install/files/lib/acp/page/PackageAutoUpdateListPage.class.php
index cddd0b2349..2244070f0a 100755
--- a/wcfsetup/install/files/lib/acp/page/PackageAutoUpdateListPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/PackageAutoUpdateListPage.class.php
@@ -17,9 +17,20 @@ use wcf\system\package\PackageUpdateDispatcher;
  * @category 	Community Framework
  */
 class PackageAutoUpdateListPage extends AbstractPage {
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'packageAutoUpdateList';
+
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.system.package.canUpdatePackage');
 	
+	/**
+	 * list with data of available updates
+	 * @var	array
+	 */
 	public $availableUpdates = array();
 	
 	/**
diff --git a/wcfsetup/install/files/lib/acp/page/PackageListPage.class.php b/wcfsetup/install/files/lib/acp/page/PackageListPage.class.php
index 725ee6d010..a5c2a24d40 100755
--- a/wcfsetup/install/files/lib/acp/page/PackageListPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/PackageListPage.class.php
@@ -16,29 +16,38 @@ use wcf\system\WCF;
  * @category 	Community Framework
  */
 class PackageListPage extends SortablePage {
-	// system
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'packageList';
+	
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canUninstallPackage');
+	
+	/**
+	 * @see wcf\page\MultipleLinkPage::$itemsPerPage
+	 */
 	public $itemsPerPage = 50;
+	
+	/**
+	 * @see wcf\page\SortablePage::$defaultSortField
+	 */
 	public $defaultSortField = 'packageType';
-	public $defaultSortOrder = 'DESC';
 	
 	/**
-	 * list of packages
-	 * 
-	 * @var	PackageList
+	 * @see wcf\page\SortablePage::$defaultSortOrder
 	 */
-	public $packageList = null;
+	public $defaultSortOrder = 'DESC';
 	
 	/**
-	 * class name for DatabaseObjectList
-	 * 
-	 * @var	string
+	 * @see	wcf\page\MultipleLinkPage::$objectListClassName
 	 */	
 	public $objectListClassName = 'wcf\data\package\PackageList';
 	
 	/**
-	 * @see	wcf\page\MuletipleLinkPage::readObjects()
+	 * @see	wcf\page\MultipleLinkPage::readObjects()
 	 */	
 	protected function readObjects() {
 		$this->sqlOrderBy = 'package.'.($this->sortField == 'packageType' ? 'standalone '.$this->sortOrder.', package.parentPackageID '.$this->sortOrder : $this->sortField.' '.$this->sortOrder).($this->sortField != 'packageName' ? ', package.packageName ASC' : '');
diff --git a/wcfsetup/install/files/lib/acp/page/PackageUpdateSearchResultPage.class.php b/wcfsetup/install/files/lib/acp/page/PackageUpdateSearchResultPage.class.php
index 6eb7786808..ef4db2063f 100755
--- a/wcfsetup/install/files/lib/acp/page/PackageUpdateSearchResultPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/PackageUpdateSearchResultPage.class.php
@@ -19,10 +19,25 @@ use wcf\system\WCF;
  * @category 	Community Framework
  */
 class PackageUpdateSearchResultPage extends SortablePage {
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'packageUpdateSearchResult';
-	public $defaultSortField = 'packageName';
+	
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canInstallPackage');
 	
+	/**
+	 * @see wcf\page\SortablePage::$defaultSortField
+	 */
+	public $defaultSortField = 'packageName';
+	
+	/**
+	 * id of the package update search
+	 * @var	integer
+	 */
 	public $searchID = 0;
 	
 	/**
@@ -30,6 +45,11 @@ class PackageUpdateSearchResultPage extends SortablePage {
 	 * @var	wcf\data\search\Search
 	 */
 	public $search = null;
+
+	/**
+	 * list with data of package updates
+	 * @var	array
+	 */
 	public $packages = array();
 	
 	/**
diff --git a/wcfsetup/install/files/lib/acp/page/PackageViewPage.class.php b/wcfsetup/install/files/lib/acp/page/PackageViewPage.class.php
index 30a673914f..a0f9ab9055 100755
--- a/wcfsetup/install/files/lib/acp/page/PackageViewPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/PackageViewPage.class.php
@@ -16,14 +16,47 @@ use wcf\system\WCF;
  * @category 	Community Framework
  */
 class PackageViewPage extends AbstractPage {
-	public $package;
-	public $packageID = 0;
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'packageView';
+	
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.system.package.canUpdatePackage', 'admin.system.package.canUninstallPackage');
+	
+	/**
+	 * list with data of required packages explicitly given in the requiredPackages
+	 * tag during installation
+	 * @var	array<string>
+	 */
 	public $requiredPackages = array();
+	
+	/**
+	 * list with data of dependent packages
+	 * @var	array<string>
+	 */
 	public $dependentPackages = array();
+	
+	/**
+	 * list with data of  required packages
+	 * @var	array<string>
+	 */
 	public $dependencies = array();
 	
+	/**
+	 * id of the package
+	 * @var	integer
+	 */
+	public $packageID = 0;
+	
+	/**
+	 * package object
+	 * @var	Package
+	 */
+	public $package = null;
+	
 	/**
 	 * @see wcf\page\IPage::readParameters()
 	 */
diff --git a/wcfsetup/install/files/lib/acp/page/UpdateServerListPage.class.php b/wcfsetup/install/files/lib/acp/page/UpdateServerListPage.class.php
index 6a30bf9fce..1fdb8be7a8 100755
--- a/wcfsetup/install/files/lib/acp/page/UpdateServerListPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/UpdateServerListPage.class.php
@@ -15,17 +15,32 @@ use wcf\system\WCF;
  * @category 	Community Framework
  */
 class UpdateServerListPage extends SortablePage {
-	// system
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'updateServerList';
+	
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.system.package.canEditServer');
+	
+	/**
+	 * @see wcf\page\SortablePage::$defaultSortField
+	 */
 	public $defaultSortField = 'serverURL';
-	public $deletedPackageUpdateServerID = 0;
 	
 	/**
 	 * @see	wcf\page\MultipleLinkPage::$objectListClassName
 	 */	
 	public $objectListClassName = 'wcf\data\package\update\server\PackageUpdateServerList';
 	
+	/**
+	 * id of a package update server that has just been deleted
+	 * @var	integer
+	 */
+	public $deletedPackageUpdateServerID = 0;
+	
 	/**
 	 * @see wcf\page\IPage::readParameters()
 	 */
diff --git a/wcfsetup/install/files/lib/acp/page/UserGroupListPage.class.php b/wcfsetup/install/files/lib/acp/page/UserGroupListPage.class.php
index 85c4f2d131..2a1d19bb84 100755
--- a/wcfsetup/install/files/lib/acp/page/UserGroupListPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/UserGroupListPage.class.php
@@ -15,17 +15,32 @@ use wcf\system\WCF;
  * @category 	Community Framework
  */
 class UserGroupListPage extends SortablePage {
-	// system
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'userGroupList';
-	public $deletedGroups = 0;
-	public $defaultSortField = 'groupName';
+	
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.user.canEditGroup', 'admin.user.canDeleteGroup');
 	
+	/**
+	 * @see wcf\page\SortablePage::$defaultSortField
+	 */
+	public $defaultSortField = 'groupName';
+	
 	/**
 	 * @see	wcf\page\MultipleLinkPage::$objectListClassName
 	 */	
 	public $objectListClassName = 'wcf\data\user\group\UserGroupList';
 	
+	/**
+	 * indicates if a group has just been deleted
+	 * @var	integer
+	 */
+	public $deletedGroups = 0;
+	
 	/**
 	 * @see wcf\page\IPage::readParameters()
 	 */
diff --git a/wcfsetup/install/files/lib/acp/page/UserListPage.class.php b/wcfsetup/install/files/lib/acp/page/UserListPage.class.php
index 58530cdd7b..3b82442f0b 100755
--- a/wcfsetup/install/files/lib/acp/page/UserListPage.class.php
+++ b/wcfsetup/install/files/lib/acp/page/UserListPage.class.php
@@ -22,13 +22,30 @@ use wcf\util\StringUtil;
  * @category 	Community Framework
  */
 class UserListPage extends SortablePage {
-	// system
-	public $itemsPerPage = 50;
-	public $defaultSortField = 'username';
+	/**
+	 * @see wcf\page\AbstractPage::$templateName
+	 */
 	public $templateName = 'userList';
+	
+	/**
+	 * @see wcf\page\AbstractPage::$neededPermissions
+	 */
 	public $neededPermissions = array('admin.user.canSearchUser');
 	
-	// parameters
+	/**
+	 * @see wcf\page\MultipleLinkPage::$itemsPerPage
+	 */
+	public $itemsPerPage = 50;
+	
+	/**
+	 * @see wcf\page\SortablePage::$defaultSortField
+	 */
+	public $defaultSortField = 'username';
+	
+	/**
+	 * id of a user search
+	 * @var	integer
+	 */
 	public $searchID = 0;
 	
 	// data
diff --git a/wcfsetup/install/files/lib/form/AbstractForm.class.php b/wcfsetup/install/files/lib/form/AbstractForm.class.php
index b19feac7d1..e907c45aef 100644
--- a/wcfsetup/install/files/lib/form/AbstractForm.class.php
+++ b/wcfsetup/install/files/lib/form/AbstractForm.class.php
@@ -18,15 +18,13 @@ use wcf\system\exception\UserInputException;
  */
 abstract class AbstractForm extends AbstractPage implements IForm {
 	/**
-	 * Name of error field.
-	 *
+	 * name of error field
 	 * @var string
 	 */
 	public $errorField = '';
 	
 	/**
-	 * Name of error type.
-	 *
+	 * error type
 	 * @var string
 	 */
 	public $errorType = '';
diff --git a/wcfsetup/install/files/lib/page/AbstractPage.class.php b/wcfsetup/install/files/lib/page/AbstractPage.class.php
index 93de49b6bd..2a2701f474 100644
--- a/wcfsetup/install/files/lib/page/AbstractPage.class.php
+++ b/wcfsetup/install/files/lib/page/AbstractPage.class.php
@@ -16,29 +16,25 @@ use wcf\system\event\EventHandler;
  */
 abstract class AbstractPage implements IPage {
 	/**
-	 * Name of the template for the called page.
-	 * 
+	 * name of the template for the called page
 	 * @var string
 	 */
 	public $templateName = '';
 	
 	/**
-	 * Value of the given action parameter.
-	 * 
+	 * value of the given action parameter
 	 * @var string
 	 */
 	public $action = '';
 	
 	/**
-	 * Needed modules to view this page.
-	 * 
+	 * needed modules to view this page
 	 * @var	array<string>
 	 */
 	public $neededModules = array();
 	
 	/**
-	 * Needed permissions to view this page.
-	 * 
+	 * needed permissions to view this page
 	 * @var array<string>
 	 */
 	public $neededPermissions = array();
diff --git a/wcfsetup/install/files/lib/page/MultipleLinkPage.class.php b/wcfsetup/install/files/lib/page/MultipleLinkPage.class.php
index 563c854802..088f4c11b5 100644
--- a/wcfsetup/install/files/lib/page/MultipleLinkPage.class.php
+++ b/wcfsetup/install/files/lib/page/MultipleLinkPage.class.php
@@ -18,64 +18,55 @@ use wcf\util\ClassUtil;
  */
 abstract class MultipleLinkPage extends AbstractPage {
 	/**
-	 * The current page number.
-	 * 
+	 * current page number
 	 * @var integer
 	 */
 	public $pageNo = 0;
 	
 	/**
-	 * The number of all pages.
-	 * 
+	 * number of all pages
 	 * @var integer
 	 */
 	public $pages = 0;
 	
 	/**
-	 * The number of items shown per page.
-	 * 
+	 * number of items shown per page
 	 * @var integer
 	 */
 	public $itemsPerPage = 20;
 	
 	/**
-	 * The number of all items.
-	 * 
+	 * number of all items
 	 * @var integer
 	 */
 	public $items = 0;
 	
 	/**
-	 * Indicates the range of the listed items.
-	 * 
+	 * indicates the range of the listed items
 	 * @var integer
 	 */
 	public $startIndex = 0;
 	
 	/**
-	 * Indicates the range of the listed items.
-	 * 
+	 * indicates the range of the listed items.
 	 * @var integer
 	 */
 	public $endIndex = 0;
 	
 	/**
 	 * DatabaseObjectList object
-	 * 
 	 * @var	wcf\data\DatabaseObjectList
 	 */	
 	public $objectList = null;
 	
 	/**
 	 * class name for DatabaseObjectList
-	 * 
 	 * @var	string
 	 */	
 	public $objectListClassName = '';
 	
 	/**
 	 * list of DatabaseObject objects
-	 * 
 	 * @var	array<wcf\data\DatabaseObject>
 	 */	
 	public $objects = array();
diff --git a/wcfsetup/install/files/lib/page/SortablePage.class.php b/wcfsetup/install/files/lib/page/SortablePage.class.php
index 76a0014dab..8fc8cba78e 100644
--- a/wcfsetup/install/files/lib/page/SortablePage.class.php
+++ b/wcfsetup/install/files/lib/page/SortablePage.class.php
@@ -16,29 +16,25 @@ use wcf\system\event\EventHandler;
  */
 abstract class SortablePage extends MultipleLinkPage {
 	/**
-	 * The selected sort field.
-	 * 
+	 * selected sort field
 	 * @var string
 	 */
 	public $sortField = '';
 	
 	/**
-	 * The selected sort order.
-	 * 
+	 * selected sort order
 	 * @var string
 	 */
 	public $sortOrder = '';
 	
 	/**
-	 * The default sort field.
-	 * 
+	 * default sort field
 	 * @var string
 	 */
 	public $defaultSortField = '';
 	
 	/**
-	 * The default sort order.
-	 * 
+	 * default sort order
 	 * @var string
 	 */
 	public $defaultSortOrder = 'ASC';
-- 
2.20.1