From bb5cd16692bf4fae43de7b7020bd5eab5f2a1e72 Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Wed, 10 Jan 2024 16:36:39 -0300 Subject: [PATCH 01/12] Generic/DocComment: add XML documentation --- .../Docs/Commenting/DocCommentStandard.xml | 394 ++++++++++++++++++ 1 file changed, 394 insertions(+) create mode 100644 src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml new file mode 100644 index 0000000000..77fac143d4 --- /dev/null +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -0,0 +1,394 @@ + + + + + + + + + + Some content. + */ + ]]> + + + + */ + ]]> + + + + + + + + /** + * Short description. + */ + ]]> + + + /** Short description. + */ + ]]> + + + + + + + + */ + ]]> + + + * Short description */ + ]]> + + + + + + + + */ + ]]> + + + * + */ + + /** + * Short description. + + */ + ]]> + + + + + + + + Short description. + */ + ]]> + + + @return int + */ + ]]> + + + + + + + + + * Short description. + */ + ]]> + + + * + * Short description. + */ + + /** + + + * Short description. + */ + ]]> + + + + + + + + Short description. + */ + ]]> + + + short description. + */ + ]]> + + + + + + + + * + * Long description. + */ + ]]> + + + * + * + + * Long description. + */ + ]]> + + + + + + + + Long description. + */ + ]]> + + + long description. + */ + ]]> + + + + + + + + * + * @param int $foo + */ + ]]> + + + * + * + * @param int $foo + */ + + /** + * Short description. + * @return int + */ + ]]> + + + + + + + + * @param int $foo + * @param string $bar + */ + ]]> + + + * + * @param string $bar + */ + ]]> + + + + + + + + * @author Some Author + * @return int + */ + ]]> + + + * @param int $foo + * @author Some Author + * @return int + */ + ]]> + + + + + + + + * + * @return int + */ + ]]> + + + * + * + * @return int + */ + ]]> + + + + + + + + 1.0.0 + * @return bool + */ + ]]> + + + 1.0.0 + * @return bool + */ + ]]> + + + + + + + + @param string $foo + * + * @return void + */ + ]]> + + + @param string $bar + */ + ]]> + + + From 6089ac65032469cc1c05bdb31fd0cbd4399fdd6d Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Wed, 28 Feb 2024 16:40:49 -0300 Subject: [PATCH 02/12] Generic/DocComment: changes to the doc based on PR review --- .../Docs/Commenting/DocCommentStandard.xml | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml index 77fac143d4..cfa7c2f9d6 100644 --- a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -83,11 +83,6 @@ /** * Short description. * - */ - - /** - * Short description. - */ ]]> @@ -130,12 +125,6 @@ * - * Short description. - */ - - /** - - * Short description. */ ]]> @@ -305,11 +294,11 @@ - + - + From 5843ebe70f2513934413d12eccc95114ae4e7d5b Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Wed, 28 Feb 2024 16:42:01 -0300 Subject: [PATCH 03/12] Generic/DocComment: update doc and replace doc comment with DocBlock --- .../Docs/Commenting/DocCommentStandard.xml | 34 +++++++++---------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml index cfa7c2f9d6..7556ab4fdd 100644 --- a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -1,23 +1,23 @@ - + Some content. */ ]]> - + @@ -27,18 +27,18 @@ - + /** * Short description. */ ]]> - + /** Short description. */ @@ -47,18 +47,18 @@ - + */ ]]> - + * Short description */ @@ -67,18 +67,18 @@ - + */ ]]> - + - + Short description. */ ]]> - + @return int @@ -110,7 +110,7 @@ From ad2cc5cf286b1f0a25e3ecba022cf3dbb854afb5 Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Thu, 29 Feb 2024 11:53:33 -0300 Subject: [PATCH 04/12] Group doc for LongNotCapital and ShortNotCapital together --- .../Docs/Commenting/DocCommentStandard.xml | 56 ++----------------- 1 file changed, 4 insertions(+), 52 deletions(-) diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml index 7556ab4fdd..c44c2a6214 100644 --- a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -132,71 +132,23 @@ - + Short description. - */ - ]]> - - - short description. - */ - ]]> - - - - - - - - * - * Long description. - */ - ]]> - - - * - * - - * Long description. - */ - ]]> - - - - - - - - Long description. */ ]]> - + short description. * * long description. */ From 15eb2db7e9f4299f96d38dc35161dd95e6e4d0c7 Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Thu, 29 Feb 2024 11:54:53 -0300 Subject: [PATCH 05/12] Group doc for SpacingBeforeTags, SpacingAfterTagGroup and SpacingBetween --- .../Docs/Commenting/DocCommentStandard.xml | 49 +++---------------- 1 file changed, 8 insertions(+), 41 deletions(-) diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml index c44c2a6214..db42b06b72 100644 --- a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -157,31 +157,30 @@ - + * + * Long description. * * @param int $foo */ ]]> - + * - * + * + + * Long description. * @param int $foo - */ - - /** - * Short description. - * @return int */ ]]> @@ -240,38 +239,6 @@ * @param int $foo * @author Some Author * @return int - */ - ]]> - - - - - - - - * - * @return int - */ - ]]> - - - * - * - * @return int */ ]]> From 1c68da9751726e7fa8385c550bdc02b11eaa994d Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Thu, 29 Feb 2024 12:00:58 -0300 Subject: [PATCH 06/12] Group doc for ContentAfterOpen and ContentBeforeClose together --- .../Docs/Commenting/DocCommentStandard.xml | 27 ++++--------------- 1 file changed, 5 insertions(+), 22 deletions(-) diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml index db42b06b72..ca9f4dbae3 100644 --- a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -27,39 +27,22 @@ - + /** * Short description. - */ + */ ]]> - + /** Short description. */ - ]]> - - - - - - - - */ - ]]> - - - * Short description */ ]]> From 500f49246c466288f86b6f4f329003673d2e7fa5 Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Thu, 29 Feb 2024 12:05:27 -0300 Subject: [PATCH 07/12] Group doc for MissingShort and SpacingBeforeShort together --- .../Docs/Commenting/DocCommentStandard.xml | 25 +++---------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml index ca9f4dbae3..c901a775b6 100644 --- a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -72,40 +72,23 @@ - + Short description. */ ]]> - + @return int */ - ]]> - - - - - - - - - * Short description. - */ - ]]> - - - * * Short description. From d592b6fb6417cd5677c614bbd5b5edd5f4b44a4d Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Wed, 27 Mar 2024 11:02:52 -0300 Subject: [PATCH 08/12] Apply suggestions from code review Co-authored-by: Juliette <663378+jrfnl@users.noreply.github.com> --- .../Docs/Commenting/DocCommentStandard.xml | 24 ++++++++----------- 1 file changed, 10 insertions(+), 14 deletions(-) diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml index c901a775b6..797747ed77 100644 --- a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -40,25 +40,21 @@ /** Short description. - */ - -/** - * Short description */ +/** Short description. */ ]]> */ + * Short description. + */ ]]> @@ -98,11 +94,11 @@ - + Short description. @@ -111,7 +107,7 @@ */ ]]> - + short description. @@ -145,8 +141,8 @@ * * - * Long description. - * @param int $foo + * Long description. + * @param int $foo */ ]]> @@ -203,7 +199,7 @@ * Short description. * * @param int $foo - * @author Some Author + * @since 5.4.8 * @return int */ ]]> From f266412cb9c68acfab384eff7bbd9f23ee9c6530 Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Wed, 27 Mar 2024 12:19:19 -0300 Subject: [PATCH 09/12] Apply remaining suggestions from code review --- .../Docs/Commenting/DocCommentStandard.xml | 30 +++++++++++-------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml index 797747ed77..283e3424a1 100644 --- a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -1,7 +1,11 @@ @@ -31,14 +35,14 @@ ]]> - + /** * Short description. */ ]]> - + /** Short description. */ ]]> @@ -186,10 +190,10 @@ /** * Short description. * - * @param int $foo + * @param int $foo * - * @author Some Author - * @return int + * @since 3.4.8 + * @deprecated 6.0.0 */ ]]> @@ -198,9 +202,9 @@ /** * Short description. * - * @param int $foo - * @since 5.4.8 - * @return int + * @param int $foo + * @since 3.4.8 + * @deprecated 6.0.0 */ ]]> @@ -216,8 +220,8 @@ /** * Short description. * - * @deprecated 1.0.0 - * @return bool + * @since 0.5.0 + * @deprecated 1.0.0 */ ]]> @@ -226,8 +230,8 @@ /** * Short description. * - * @deprecated 1.0.0 - * @return bool + * @since 0.5.0 + * @deprecated 1.0.0 */ ]]> From 250effaaba81a62b428e80bc194ac1cbc84b5d39 Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Thu, 28 Mar 2024 10:53:30 -0300 Subject: [PATCH 10/12] Move standard about additional lines before closing tag to end Based on suggestion during PR review --- .../Docs/Commenting/DocCommentStandard.xml | 44 +++++++++---------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml index 283e3424a1..f5d7e13c04 100644 --- a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -50,28 +50,6 @@ - - - - - */ - ]]> - - - * - */ - ]]> - - - - @@ -261,6 +239,28 @@ * @return void * * @param string $bar + */ + ]]> + + + + + + + + + */ + ]]> + + + * */ ]]> From b42cc51832a3a69790a5bc23d6d9f739b6a77144 Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Mon, 20 May 2024 12:31:54 -0300 Subject: [PATCH 11/12] Further changes to the description --- src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml index f5d7e13c04..25a1839986 100644 --- a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -3,7 +3,8 @@ From 80dee1983fad7c6fd2ada46693a3e8c7fa828f25 Mon Sep 17 00:00:00 2001 From: Rodrigo Primo Date: Mon, 20 May 2024 12:34:38 -0300 Subject: [PATCH 12/12] Apply suggestions from code review Co-authored-by: Juliette <663378+jrfnl@users.noreply.github.com> --- .../Generic/Docs/Commenting/DocCommentStandard.xml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml index 25a1839986..bbeb4f69aa 100644 --- a/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml +++ b/src/Standards/Generic/Docs/Commenting/DocCommentStandard.xml @@ -11,7 +11,7 @@ @@ -250,14 +250,14 @@ ]]> - + */ ]]> - +