composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-02-13 07:24:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

📝 PHPDoc reworked packages

Browse Source
This commit is contained in:
Eric Espie
2022-12-30 11:24:03 +01:00
parent 3920f84f45
commit 626ba7ee66
26 changed files with 31 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
application/applicationextension.inc.php
View File

@@ -1221,7 +1221,7 @@ interface iPageUIExtension
* the specified place and can use the passed iTopWebPage object to add javascript or CSS definitions
*
* @api
* @package UIBlockExtensibilityAPI
* @package BackofficeUIExtensibilityAPI
* @since 3.0.0
*/
interface iPageUIBlockExtension
@@ -1679,7 +1679,7 @@ interface iRestServiceProvider
* Minimal REST response structure. Derive this structure to add response data and error codes.
*
* @api
* @package RESTExtensibilityAPI
* @package RESTAPI
* @since 2.0.1
*/
class RestResult
@@ -1772,7 +1772,7 @@ class RestResult
* Helpers for implementing REST services
*
* @api
* @package RESTExtensibilityAPI
* @package RESTAPI
*/
class RestUtils
{

8
core/restservices.class.inc.php
View File

@@ -30,7 +30,7 @@
/**
* Element of the response formed by RestResultWithObjects
*
* @package RESTExtensibilityAPI
* @package RESTAPI
* @api
*/
class ObjectResult
@@ -163,7 +163,7 @@ class ObjectResult
/**
* REST response for services managing objects. Derive this structure to add information and/or constants
*
* @package RESTExtensibilityAPI
* @package RESTAPI
* @api
*/
class RestResultWithObjects extends RestResult
@@ -224,7 +224,7 @@ class RestResultWithObjects extends RestResult
}
/**
* @package RESTExtensibilityAPI
* @package RESTAPI
* @api
*/
class RestResultWithRelations extends RestResultWithObjects
@@ -260,7 +260,7 @@ class RestResultWithRelations extends RestResultWithObjects
/**
* Deletion result codes for a target object (either deleted or updated)
*
* @package RESTExtensibilityAPI
* @package RESTAPI
* @api
* @since 2.0.1
*/

2
sources/Application/UI/Base/AbstractUIBlockFactory.php
View File

@@ -14,7 +14,7 @@ namespace Combodo\iTop\Application\UI\Base;
* @package UIBlockExtensibilityAPI
* @author Eric Espie <eric.espie@combodo.com>
* @since 3.0.0
* @api
* @internal
*/
abstract class AbstractUIBlockFactory implements iUIBlockFactory
{

2
sources/Application/UI/Base/Component/Alert/AlertUIBlockFactory.php
View File

@@ -25,7 +25,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class AlertUIBlockFactory
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @since 3.0.0
* @api
*

2
sources/Application/UI/Base/Component/Button/ButtonUIBlockFactory.php
View File

@@ -27,7 +27,7 @@ use utils;
* Class ButtonUIBlockFactory
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*

2
sources/Application/UI/Base/Component/ButtonGroup/ButtonGroupUIBlockFactory.php
View File

@@ -15,7 +15,7 @@ use Combodo\iTop\Application\UI\Base\Component\PopoverMenu\PopoverMenu;
* Class ButtonGroupUIBlockFactory
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/CollapsibleSection/CollapsibleSectionUIBlockFactory.php
View File

@@ -14,7 +14,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class CollapsibleSectionUIBlockFactory
*
* @author Pierre Goiffon <pierre.goiffon@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php
View File

@@ -38,7 +38,7 @@ use WebPage;
* Class DataTableUIBlockFactory
*
* @author Anne-Catherine Cognet <anne-catherine.cognet@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/Field/FieldUIBlockFactory.php
View File

@@ -17,7 +17,7 @@ use Combodo\iTop\Application\UI\Base\UIBlock;
* Use it to make a "field" which is composed of a label and a value (which can be read-only or editable)
*
* @api
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @author Pierre Goiffon <pierre.goiffon@combodo.com>
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/FieldBadge/FieldBadgeUIBlockFactory.php
View File

@@ -16,7 +16,7 @@ use utils;
* Class FieldBadgeUIBlockFactory
*
* @author Eric espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @since 3.0.0
* @internal
*/

2
sources/Application/UI/Base/Component/FieldSet/FieldSetUIBlockFactory.php
View File

@@ -14,7 +14,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class FieldSetUIBlockFactory
*
* @author eric Espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/Form/FormUIBlockFactory.php
View File

@@ -14,7 +14,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class FormUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package UUIBlockExtensibilityAPI
* @package UIBlockAPI
* @since 3.0.0
* @api
*/

2
sources/Application/UI/Base/Component/Input/FileSelect/FileSelectUIBlockFactory.php
View File

@@ -14,7 +14,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class FileSelectUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/Input/InputUIBlockFactory.php
View File

@@ -15,7 +15,7 @@ use Combodo\iTop\Application\UI\Base\Component\Field\Field;
* Class InputUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/Input/Select/SelectOptionUIBlockFactory.php
View File

@@ -14,7 +14,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class SelectOptionUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/Input/Select/SelectUIBlockFactory.php
View File

@@ -15,7 +15,7 @@ use Combodo\iTop\Application\UI\Base\Component\Input\Select\Select;
* Class SelectUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/Panel/PanelUIBlockFactory.php
View File

@@ -25,7 +25,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class PanelUIBlockFactory
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*

2
sources/Application/UI/Base/Component/Spinner/SpinnerUIBlockFactory.php
View File

@@ -14,7 +14,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class SpinnerUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/Template/TemplateUIBlockFactory.php
View File

@@ -28,7 +28,7 @@ use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock;
* @api
*
* @author Benjamin Dalsass <benjamin.dalsass@combodo.com>
* @package Combodo\iTop\Application\UI\Base\Component\Template
* @package UIBlockAPI
* @since 3.1.0
* @link
*/

2
sources/Application/UI/Base/Component/Title/TitleUIBlockFactory.php
View File

@@ -16,7 +16,7 @@ use Combodo\iTop\Application\UI\Base\UIBlock;
* Class TitleUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/Toolbar/Separator/ToolbarSeparatorUIBlockFactory.php
View File

@@ -14,7 +14,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class ToolbarSeparatorUIBlockFactory
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/Toolbar/ToolbarSpacer/ToolbarSpacerUIBlockFactory.php
View File

@@ -14,7 +14,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class ToolbarSpacerUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Component/Toolbar/ToolbarUIBlockFactory.php
View File

@@ -14,7 +14,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class ToolbarUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/

2
sources/Application/UI/Base/Layout/MultiColumn/Column/ColumnUIBlockFactory.php
View File

@@ -15,7 +15,7 @@ use Combodo\iTop\Application\UI\Base\UIBlock;
* Class ColumnUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @since 3.0.0
* @api
*/

2
sources/Application/UI/Base/Layout/MultiColumn/MultiColumnUIBlockFactory.php
View File

@@ -13,7 +13,7 @@ use Combodo\iTop\Application\UI\Base\AbstractUIBlockFactory;
* Class MultiColumnUIBlockFactory
*
* @author Eric Espie <eric.espie@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @since 3.0.0
* @api
*/

2
sources/Application/UI/Base/Layout/UIContentBlockUIBlockFactory.php
View File

@@ -15,7 +15,7 @@ use Combodo\iTop\Application\UI\Base\Component\Html\Html;
* Class UIContentBlockUIBlockFactory
*
* @author Guillaume Lajarige <guillaume.lajarige@combodo.com>
* @package UIBlockExtensibilityAPI
* @package UIBlockAPI
* @api
* @since 3.0.0
*/