From 04fc58b55c1860868bc46e73e490997c69d030c3 Mon Sep 17 00:00:00 2001 From: Pierre Goiffon Date: Fri, 21 Feb 2020 18:01:08 +0100 Subject: [PATCH] :memo: Some @since annotations were missing complete version (ex 2.5 instead of 2.5.0) --- application/applicationextension.inc.php | 2 +- application/cmdbabstract.class.inc.php | 4 ++-- application/dashlet.class.inc.php | 2 +- application/itopwebpage.class.inc.php | 2 +- application/pdfpage.class.inc.php | 2 +- core/attributedef.class.inc.php | 4 ++-- core/cmdbsource.class.inc.php | 12 ++++++------ core/config.class.inc.php | 2 +- core/coreexception.class.inc.php | 2 +- core/dbobject.class.php | 10 +++++----- core/dbobjectsearch.class.php | 2 +- core/legacy/dbobjectsearchlegacy.class.php | 2 +- core/metamodel.class.php | 8 ++++---- core/oql/expression.class.inc.php | 2 +- core/tagsetfield.class.inc.php | 2 +- .../templates/helpers/tagset_clic_handler.js.twig | 2 +- setup/applicationinstaller.class.inc.php | 8 +++++--- setup/backup.class.inc.php | 6 +++--- setup/runtimeenv.class.inc.php | 2 +- test/core/MetaModelTest.php | 2 +- test/core/UniquenessConstraintTest.php | 2 +- 21 files changed, 41 insertions(+), 39 deletions(-) diff --git a/application/applicationextension.inc.php b/application/applicationextension.inc.php index 56aceb061..f4d751443 100644 --- a/application/applicationextension.inc.php +++ b/application/applicationextension.inc.php @@ -1065,7 +1065,7 @@ abstract class AbstractPageUIExtension implements iPageUIExtension * * @api * @package Extensibility - * @since 2.4 + * @since 2.4.0 */ interface iPortalUIExtension { diff --git a/application/cmdbabstract.class.inc.php b/application/cmdbabstract.class.inc.php index c563141ee..7602639b0 100644 --- a/application/cmdbabstract.class.inc.php +++ b/application/cmdbabstract.class.inc.php @@ -150,7 +150,7 @@ EOF * @param bool $bMustNotExist * * @see SetSessionMessage() - * @since 2.6 + * @since 2.6.0 */ protected function SetSessionMessageFromInstance($sMessageId, $sMessage, $sSeverity, $fRank, $bMustNotExist = false) { @@ -4025,7 +4025,7 @@ EOF /** * @param string $sMessageIdPrefix * - * @since 2.6 + * @since 2.6.0 */ protected function SetWarningsAsSessionMessages($sMessageIdPrefix) { diff --git a/application/dashlet.class.inc.php b/application/dashlet.class.inc.php index 8f0a4db90..a54c8beb8 100644 --- a/application/dashlet.class.inc.php +++ b/application/dashlet.class.inc.php @@ -514,7 +514,7 @@ EOF * * Used as a fallback in iTop for unknown dashlet classes. * - * @since 2.5 + * @since 2.5.0 */ class DashletUnknown extends Dashlet { diff --git a/application/itopwebpage.class.inc.php b/application/itopwebpage.class.inc.php index bc24b877f..e7862fe34 100644 --- a/application/itopwebpage.class.inc.php +++ b/application/itopwebpage.class.inc.php @@ -1645,7 +1645,7 @@ EOF; * @param string $sCssClasses CSS classes to add to the container * * @throws \Exception - * @since 2.6 + * @since 2.6.0 */ public function AddHeaderMessage($sContent, $sCssClasses = 'message_info') { diff --git a/application/pdfpage.class.inc.php b/application/pdfpage.class.inc.php index 87671264e..53e419df1 100644 --- a/application/pdfpage.class.inc.php +++ b/application/pdfpage.class.inc.php @@ -40,7 +40,7 @@ class iTopPDF extends TCPDF * * @uses \TCPDF::SetFont() * @uses \iTopPDF::GetPdfFont() - * @since 2.7 + * @since 2.7.0 */ public function SetFontParams($style, $size, $fontfile='', $subset='default', $out=true) { diff --git a/core/attributedef.class.inc.php b/core/attributedef.class.inc.php index b2a2953b2..42b597d9a 100644 --- a/core/attributedef.class.inc.php +++ b/core/attributedef.class.inc.php @@ -3740,7 +3740,7 @@ class AttributeFinalClass extends AttributeString /** * @return bool - * @since 2.7 + * @since 2.7.0 N°2272 OQL perf finalclass in all intermediary tables */ public function CopyOnAllTables() { @@ -10829,7 +10829,7 @@ class AttributeQueryAttCodeSet extends AttributeSet * Multi value list of tags * * @see TagSetFieldData - * @since 2.6 N°931 tag fields + * @since 2.6.0 N°931 tag fields */ class AttributeTagSet extends AttributeSet { diff --git a/core/cmdbsource.class.inc.php b/core/cmdbsource.class.inc.php index 3b72e76ee..632e9caae 100644 --- a/core/cmdbsource.class.inc.php +++ b/core/cmdbsource.class.inc.php @@ -64,7 +64,7 @@ class MySQLException extends CoreException /** * Class MySQLQueryHasNoResultException * - * @since 2.5 + * @since 2.5.0 */ class MySQLQueryHasNoResultException extends MySQLException { @@ -74,7 +74,7 @@ class MySQLQueryHasNoResultException extends MySQLException /** * Class MySQLHasGoneAwayException * - * @since 2.5 + * @since 2.5.0 * @see itop bug 1195 * @see https://dev.mysql.com/doc/refman/5.7/en/gone-away.html */ @@ -126,12 +126,12 @@ class CMDBSource protected static $m_sDBName; /** * @var boolean - * @since 2.5 N°1260 MySQL TLS first implementation + * @since 2.5.0 N°1260 MySQL TLS first implementation */ protected static $m_bDBTlsEnabled; /** * @var string - * @since 2.5 N°1260 MySQL TLS first implementation + * @since 2.5.0 N°1260 MySQL TLS first implementation */ protected static $m_sDBTlsCA; @@ -1390,7 +1390,7 @@ class CMDBSource * @return string query to upgrade table charset and collation if needed, null if not * @throws \MySQLException * - * @since 2.5 N°1001 switch to utf8mb4 + * @since 2.5.0 N°1001 switch to utf8mb4 * @see https://dev.mysql.com/doc/refman/5.7/en/charset-table.html */ public static function DBCheckTableCharsetAndCollation($sTableName) @@ -1540,7 +1540,7 @@ class CMDBSource * @return string query to upgrade database charset and collation if needed, null if not * @throws \MySQLException * - * @since 2.5 N°1001 switch to utf8mb4 + * @since 2.5.0 N°1001 switch to utf8mb4 * @see https://dev.mysql.com/doc/refman/5.7/en/charset-database.html */ public static function DBCheckCharsetAndCollation() diff --git a/core/config.class.inc.php b/core/config.class.inc.php index dc7fd40b2..662f8539b 100644 --- a/core/config.class.inc.php +++ b/core/config.class.inc.php @@ -361,7 +361,7 @@ class Config 'source_of_value' => '', 'show_in_conf_sample' => true, ), - 'export_pdf_font' => array( // @since 2.7 PR #49 + 'export_pdf_font' => array( // @since 2.7.0 PR #49 / N°1947 'type' => 'string', 'description' => 'Font used when generating a PDF file', 'default' => 'DejaVuSans', // DejaVuSans is a UTF-8 Unicode font, embedded in the TCPPDF lib we're using diff --git a/core/coreexception.class.inc.php b/core/coreexception.class.inc.php index 0017955ed..81ba9efef 100644 --- a/core/coreexception.class.inc.php +++ b/core/coreexception.class.inc.php @@ -115,7 +115,7 @@ class CoreException extends Exception * @see \DBObject::DBInsertNoReload() * @see \DBObject::DBUpdate() * - * @since 2.6 N°659 uniqueness constraint + * @since 2.6.0 N°659 uniqueness constraint */ class CoreCannotSaveObjectException extends CoreException { diff --git a/core/dbobject.class.php b/core/dbobject.class.php index f280c42c3..db6dddf84 100644 --- a/core/dbobject.class.php +++ b/core/dbobject.class.php @@ -116,7 +116,7 @@ abstract class DBObject implements iDisplay /** * @var null|string[] list of warnings thrown during DB write * @see CheckToWrite() - * @since 2.6 N°659 uniqueness constraints + * @since 2.6.0 N°659 uniqueness constraints */ protected $m_aCheckWarnings = null; protected $m_aDeleteIssues = null; @@ -645,7 +645,7 @@ abstract class DBObject implements iDisplay * @throws \CoreException * @throws \CoreUnexpectedValue * @throws \Exception - * @since 2.6 + * @since 2.6.0 */ public function SetIfNull($sAttCode, $value) { @@ -1987,7 +1987,7 @@ abstract class DBObject implements iDisplay * @throws \CoreException * @throws \OQLException * - * @since 2.6 N°659 uniqueness constraint + * @since 2.6.0 N°659 uniqueness constraint * @api */ protected function DoCheckUniqueness() @@ -2035,7 +2035,7 @@ abstract class DBObject implements iDisplay * @return string dict key : Class:$sClassName/UniquenessRule:$sUniquenessRuleId if none then will use Core:UniquenessDefaultError * Dictionary keys can contain "$this" placeholders * - * @since 2.6 N°659 uniqueness constraint + * @since 2.6.0 N°659 uniqueness constraint */ protected function GetUniquenessRuleMessage($sUniquenessRuleId) { @@ -2087,7 +2087,7 @@ abstract class DBObject implements iDisplay * @return \DBSearch * @throws \CoreException * @throws \OQLException - * @since 2.6 N°659 uniqueness constraint + * @since 2.6.0 N°659 uniqueness constraint * @api */ protected function GetSearchForUniquenessRule($sUniquenessRuleId, $aUniquenessRuleProperties) diff --git a/core/dbobjectsearch.class.php b/core/dbobjectsearch.class.php index d5a2fc848..bff609535 100644 --- a/core/dbobjectsearch.class.php +++ b/core/dbobjectsearch.class.php @@ -528,7 +528,7 @@ class DBObjectSearch extends DBSearch * * @throws \CoreException * - * @since 2.5 N°1418 + * @since 2.5.0 N°1418 */ public function AddConditionForInOperatorUsingParam($sFilterCode, $aValues, $bPositiveMatch = true) { diff --git a/core/legacy/dbobjectsearchlegacy.class.php b/core/legacy/dbobjectsearchlegacy.class.php index 5a153521d..15d1fce2c 100644 --- a/core/legacy/dbobjectsearchlegacy.class.php +++ b/core/legacy/dbobjectsearchlegacy.class.php @@ -546,7 +546,7 @@ class DBObjectSearch extends DBSearch * * @throws \CoreException * - * @since 2.5 N°1418 + * @since 2.5.0 N°1418 */ public function AddConditionForInOperatorUsingParam($sFilterCode, $aValues, $bPositiveMatch = true) { diff --git a/core/metamodel.class.php b/core/metamodel.class.php index 187dd760e..b743ae5cd 100644 --- a/core/metamodel.class.php +++ b/core/metamodel.class.php @@ -543,7 +543,7 @@ abstract class MetaModel * * @return array rule id as key, rule properties as value * @throws \CoreException - * @since 2.6 N°659 uniqueness constraint + * @since 2.6.0 N°659 uniqueness constraint * @see #SetUniquenessRuleRootClass that fixes a specific 'root_class' property to know which class is root per rule */ final public static function GetUniquenessRules($sClass, $bClassDefinitionOnly = false) @@ -688,7 +688,7 @@ abstract class MetaModel * @param array $aRuleProperties * * @return bool - * @since 2.6 N°659 uniqueness constraint + * @since 2.6.0 N°659 uniqueness constraint */ private static function IsUniquenessRuleContainingOnlyDisabledKey($aRuleProperties) { @@ -3241,7 +3241,7 @@ abstract class MetaModel * * @throws \CoreUnexpectedValue if the rule is invalid * - * @since 2.6 N°659 uniqueness constraint + * @since 2.6.0 N°659 uniqueness constraint * @since 2.6.1 N°1968 (joli mois de mai...) disallow overrides of 'attributes' properties */ public static function CheckUniquenessRuleValidity($aUniquenessRuleProperties, $bRuleOverride = true, $aExistingClassFields = array()) @@ -6799,7 +6799,7 @@ abstract class MetaModel * @throws CoreException if no result found and $bMustBeFound=true * @throws \Exception * - * @since 2.4 introduction of the archive functionalities + * @since 2.4.0 introduction of the archive functionality * * @see MetaModel::GetObject() same but returns null or ArchivedObjectFoundException if object exists but is * archived diff --git a/core/oql/expression.class.inc.php b/core/oql/expression.class.inc.php index d8226663e..90335f9ed 100644 --- a/core/oql/expression.class.inc.php +++ b/core/oql/expression.class.inc.php @@ -811,7 +811,7 @@ class BinaryExpression extends Expression /** - * @since 2.6 N°931 tag fields + * @since 2.6.0 N°931 tag fields */ class MatchExpression extends BinaryExpression { diff --git a/core/tagsetfield.class.inc.php b/core/tagsetfield.class.inc.php index 2e82b5002..9e7238d9c 100644 --- a/core/tagsetfield.class.inc.php +++ b/core/tagsetfield.class.inc.php @@ -25,7 +25,7 @@ * \MFCompiler::CompileClass).
Only this abstract class will exists in the DB : the implementations won't had any * new field. * - * @since 2.6 N°931 tag fields + * @since 2.6.0 N°931 tag fields */ abstract class TagSetFieldData extends cmdbAbstractObject { diff --git a/datamodels/2.x/itop-portal-base/portal/templates/helpers/tagset_clic_handler.js.twig b/datamodels/2.x/itop-portal-base/portal/templates/helpers/tagset_clic_handler.js.twig index 7a7a772bc..b1de643c5 100644 --- a/datamodels/2.x/itop-portal-base/portal/templates/helpers/tagset_clic_handler.js.twig +++ b/datamodels/2.x/itop-portal-base/portal/templates/helpers/tagset_clic_handler.js.twig @@ -1,6 +1,6 @@ /** * When clicking on a TagSet item in a list (BrowseBrick or ManageBrick), filters the list using the item label - * @since 2.6 N°931 AttributeTagSet + * @since 2.6.0 N°931 AttributeTagSet */ $("#main-content").on("click", ".table.dataTable .attribute.attribute-set.attribute-tag-set > .attribute-set-item", function () { var $this = $(this), diff --git a/setup/applicationinstaller.class.inc.php b/setup/applicationinstaller.class.inc.php index 5403e3bf3..004094b1e 100644 --- a/setup/applicationinstaller.class.inc.php +++ b/setup/applicationinstaller.class.inc.php @@ -493,10 +493,12 @@ class ApplicationInstaller * @param Config $oConfig * @param string $sBackupFileFormat * @param string $sSourceConfigFile + * @param string $sMySQLBinDir * - * @throws \Exception - * - * @since 2.5 uses a {@link Config} object to store DB parameters + * @throws \BackupException + * @throws \CoreException + * @throws \MySQLException + * @since 2.5.0 uses a {@link Config} object to store DB parameters */ protected static function DoBackup($oConfig, $sBackupFileFormat, $sSourceConfigFile, $sMySQLBinDir = null) { diff --git a/setup/backup.class.inc.php b/setup/backup.class.inc.php index 44dbb2420..a24262922 100644 --- a/setup/backup.class.inc.php +++ b/setup/backup.class.inc.php @@ -80,7 +80,7 @@ class DBBackup /** * utf8mb4 was added in MySQL 5.5.3 but works with programs like mysqldump only since MySQL 5.5.33 * - * @since 2.5 see N°1001 + * @since 2.5.0 see N°1001 */ const MYSQL_VERSION_WITH_UTF8MB4_IN_PROGRAMS = '5.5.33'; @@ -112,7 +112,7 @@ class DBBackup * @param Config $oConfig object containing the database configuration.
* If null then uses the default configuration ({@see MetaModel::GetConfig}) * - * @since 2.5 uses a Config object instead of passing each attribute (there were far too many with the addition of MySQL TLS parameters + * @since 2.5.0 uses a Config object instead of passing each attribute (there were far too many with the addition of MySQL TLS parameters * !) */ public function __construct($oConfig = null) @@ -468,7 +468,7 @@ EOF; * * @return string TLS arguments for CLI programs such as mysqldump. Empty string if the config does not use TLS. * - * @since 2.5 + * @since 2.5.0 */ public static function GetMysqlCliTlsOptions($oConfig) { diff --git a/setup/runtimeenv.class.inc.php b/setup/runtimeenv.class.inc.php index f34b854f0..a222fd98f 100644 --- a/setup/runtimeenv.class.inc.php +++ b/setup/runtimeenv.class.inc.php @@ -904,7 +904,7 @@ class RunTimeEnvironment * * @param string $sQuery * - * @since 2.5 N°1001 utf8mb4 switch + * @since 2.5.0 N°1001 utf8mb4 switch * @uses \SetupUtils::GetSetupQueriesFilePath() */ protected function log_db_query($sQuery) diff --git a/test/core/MetaModelTest.php b/test/core/MetaModelTest.php index cfef62313..c0bd95fa9 100644 --- a/test/core/MetaModelTest.php +++ b/test/core/MetaModelTest.php @@ -13,7 +13,7 @@ use MetaModel; * @preserveGlobalState disabled * @backupGlobals disabled * - * @since 2.6 + * @since 2.6.0 * @package Combodo\iTop\Test\UnitTest\Core */ class MetaModelTest extends ItopDataTestCase diff --git a/test/core/UniquenessConstraintTest.php b/test/core/UniquenessConstraintTest.php index 96c454cd5..a583c4815 100644 --- a/test/core/UniquenessConstraintTest.php +++ b/test/core/UniquenessConstraintTest.php @@ -10,7 +10,7 @@ use MetaModel; /** * Class UniquenessConstraintTest * - * @since 2.6 N°659 uniqueness constraint + * @since 2.6.0 N°659 uniqueness constraint * * @package Combodo\iTop\Test\UnitTest\Core */