MINOR Fixed phpdoc documentation

git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/cms/trunk@103384 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2010-04-23 00:11:32 +00:00
parent d565c5021b
commit 01b02969f9
6 changed files with 50 additions and 1 deletions

View File

@ -475,7 +475,7 @@ class LeftAndMain extends Controller {
* shown * shown
* @param $childrenMethod The method to call to get the children of the tree. For example, * @param $childrenMethod The method to call to get the children of the tree. For example,
* Children, AllChildrenIncludingDeleted, or AllHistoricalChildren * Children, AllChildrenIncludingDeleted, or AllHistoricalChildren
* @return String Nested <ul> list with links to each page * @return String Nested unordered list with links to each page
*/ */
function getSiteTreeFor($className, $rootID = null, $childrenMethod = null, $numChildrenMethod = null, $filterFunction = null, $minNodeCount = 30) { function getSiteTreeFor($className, $rootID = null, $childrenMethod = null, $numChildrenMethod = null, $filterFunction = null, $minNodeCount = 30) {
// Default childrenMethod and numChildrenMethod // Default childrenMethod and numChildrenMethod
@ -1214,6 +1214,10 @@ class LeftAndMain extends Controller {
} }
/**
* @package cms
* @subpackage core
*/
class LeftAndMainMarkingFilter { class LeftAndMainMarkingFilter {
/** /**

View File

@ -13,6 +13,7 @@
* - members of a provided group * - members of a provided group
* - all members * - all members
* - members based on a search-query * - members based on a search-query
*
* @package cms * @package cms
* @subpackage security * @subpackage security
*/ */
@ -447,6 +448,10 @@ class MemberTableField_Popup extends ComplexTableField_Popup {
} }
/**
* @package cms
* @subpackage security
*/
class MemberTableField_Item extends ComplexTableField_Item { class MemberTableField_Item extends ComplexTableField_Item {
function Actions() { function Actions() {
@ -474,6 +479,11 @@ class MemberTableField_Item extends ComplexTableField_Item {
} }
} }
/**
* @package cms
* @subpackage security
*/
class MemberTableField_ItemRequest extends ComplexTableField_ItemRequest { class MemberTableField_ItemRequest extends ComplexTableField_ItemRequest {
/** /**

View File

@ -2,6 +2,9 @@
/** /**
* Admin interface for Permission Roles. * Admin interface for Permission Roles.
*
* @package cms
* @subpackage security
*/ */
class PermissionRoleAdmin extends ModelAdmin { class PermissionRoleAdmin extends ModelAdmin {
static $managed_models = array( static $managed_models = array(
@ -17,6 +20,9 @@ class PermissionRoleAdmin extends ModelAdmin {
/** /**
* Customized controller for hiding permissions on AddForm * Customized controller for hiding permissions on AddForm
*
* @package cms
* @subpackage security
*/ */
class PermissionRoleAdmin_CollectionController extends ModelAdmin_CollectionController { class PermissionRoleAdmin_CollectionController extends ModelAdmin_CollectionController {
public function AddForm() { public function AddForm() {
@ -31,6 +37,9 @@ class PermissionRoleAdmin_CollectionController extends ModelAdmin_CollectionCont
/** /**
* Customized controller for hiding permissions on EditForm * Customized controller for hiding permissions on EditForm
*
* @package cms
* @subpackage security
*/ */
class PermissionRoleAdmin_RecordController extends ModelAdmin_RecordController { class PermissionRoleAdmin_RecordController extends ModelAdmin_RecordController {
public function EditForm() { public function EditForm() {

View File

@ -2,6 +2,7 @@
/** /**
* Base class for the small reports that appear in the left hand site of the Site Content section of the CMS. * Base class for the small reports that appear in the left hand site of the Site Content section of the CMS.
* Create subclasses of this class to build new reports. * Create subclasses of this class to build new reports.
*
* @package cms * @package cms
* @subpackage content * @subpackage content
*/ */
@ -92,6 +93,7 @@ abstract class SideReport extends Object {
/** /**
* Content side-report listing empty pages * Content side-report listing empty pages
*
* @package cms * @package cms
* @subpackage content * @subpackage content
*/ */
@ -117,6 +119,7 @@ class SideReport_EmptyPages extends SideReport {
/** /**
* Content side-report listing recently editing pages. * Content side-report listing recently editing pages.
*
* @package cms * @package cms
* @subpackage content * @subpackage content
*/ */
@ -141,6 +144,10 @@ class SideReport_RecentlyEdited extends SideReport {
} }
} }
/**
* @package cms
* @subpackage content
*/
class SideReport_ToDo extends SideReport { class SideReport_ToDo extends SideReport {
function title() { function title() {
return _t('SideReport.TODO',"Pages with To Do items"); return _t('SideReport.TODO',"Pages with To Do items");
@ -170,6 +177,7 @@ class SideReport_ToDo extends SideReport {
/** /**
* Content side-report listing pages with broken links * Content side-report listing pages with broken links
*
* @package cms * @package cms
* @subpackage content * @subpackage content
*/ */
@ -204,6 +212,7 @@ class SideReport_BrokenLinks extends SideReport {
/** /**
* Content side-report listing pages with broken files * Content side-report listing pages with broken files
* or asset links * or asset links
*
* @package cms * @package cms
* @subpackage content * @subpackage content
*/ */
@ -235,6 +244,10 @@ class SideReport_BrokenFiles extends SideReport {
} }
} }
/**
* @package cms
* @subpackage content
*/
class SideReport_BrokenVirtualPages extends SideReport { class SideReport_BrokenVirtualPages extends SideReport {
function title() { function title() {
return _t('SideReport.BROKENVIRTUALPAGES', 'VirtualPages pointing to deleted pages'); return _t('SideReport.BROKENVIRTUALPAGES', 'VirtualPages pointing to deleted pages');
@ -261,6 +274,10 @@ class SideReport_BrokenVirtualPages extends SideReport {
} }
} }
/**
* @package cms
* @subpackage content
*/
class SideReport_BrokenRedirectorPages extends SideReport { class SideReport_BrokenRedirectorPages extends SideReport {
function title() { function title() {
return _t('SideReport.BROKENREDIRECTORPAGES', 'RedirectorPages pointing to deleted pages'); return _t('SideReport.BROKENREDIRECTORPAGES', 'RedirectorPages pointing to deleted pages');

View File

@ -1,6 +1,7 @@
<?php <?php
/** /**
* Represents a single comment on a page * Represents a single comment on a page
*
* @package cms * @package cms
* @subpackage comments * @subpackage comments
*/ */
@ -158,6 +159,10 @@ class PageComment extends DataObject {
} }
/**
* @package cms
* @subpackage comments
*/
class PageComment_Controller extends Controller { class PageComment_Controller extends Controller {
function rss() { function rss() {
$parentcheck = isset($_REQUEST['pageid']) ? "\"ParentID\" = " . (int) $_REQUEST['pageid'] : "\"ParentID\" > 0"; $parentcheck = isset($_REQUEST['pageid']) ? "\"ParentID\" = " . (int) $_REQUEST['pageid'] : "\"ParentID\" > 0";

View File

@ -1,4 +1,8 @@
<?php <?php
/**
* @package cms
* @subpackage assets
*/
class FilesystemSyncTask extends BuildTask { class FilesystemSyncTask extends BuildTask {
protected $title = "Sync Files & Images assets"; protected $title = "Sync Files & Images assets";