Differential D2663

Document UUID class
ClosedPublic
Actions

Authored by dereckson on Apr 10 2022, 12:29.

Tags

None

Referenced Files

	F3765500: D2663.diff
	Fri, Nov 22, 12:39

	Unknown Object (File)
	Tue, Nov 19, 06:42

	Unknown Object (File)
	Tue, Nov 19, 02:09

	Unknown Object (File)
	Tue, Nov 19, 01:15

	Unknown Object (File)
	Sun, Nov 17, 20:51

	Unknown Object (File)
	Sun, Nov 17, 19:03

	Unknown Object (File)
	Sun, Nov 17, 04:02

	Unknown Object (File)
	Thu, Nov 14, 20:48

Subscribers

None

Details

Reviewers

Commits

rKOT09897d22e580: Document UUID class
rKOTb14ea14ba504: Document UUID class
rKERUALD1c60bfef585a: Document UUID class

Summary

Include more PHPDoc information to help to generate documentation.

PHP documentation tools consider constants public by default,
but some are for internals use.

Test Plan

Regenerate doc with Doctum

Diff Detail

Repository

rKERUALD Keruald libraries development repository

Lint

Lint Errors

Severity	Location	Code	Message
Error	omnitools/src/Identifiers/UUID.php:42	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:43	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:70	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:136	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:137	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:164	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Warning	omnitools/src/Identifiers/UUID.php:16	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong

Unit

Test Failures

Branch

main

Build Status

Buildable 4175
Build 4427: arc lint + arc unit

Unit TestsBroken
View All

	Time	Test
	0 ms	/home/dereckson/dev/nasqueron/keruald/omnitools/tests/Identifiers/UUIDTest.php

Event Timeline

dereckson requested review of this revision.Apr 10 2022, 12:29

dereckson created this revision.

Harbormaster completed remote builds in B4175: Diff 6730.Apr 10 2022, 12:29

Doc

Harbormaster completed remote builds in B4176: Diff 6731.Apr 10 2022, 13:21

dereckson retitled this revision from Address UUID constants visibility to Document UUID class.Apr 10 2022, 13:21

dereckson edited the summary of this revision. (Show Details)

dereckson planned changes to this revision.Apr 14 2022, 22:00

Looks good to me, ready to merge.

This revision was not accepted when it landed; it landed in state Changes Planned.Feb 24 2023, 19:57

This revision was landed with ongoing or failed builds.

Closed by commit rKERUALD1c60bfef585a: Document UUID class (authored by dereckson). · Explain Why

This revision was automatically updated to reflect the committed changes.

dereckson added a commit: rKERUALD1c60bfef585a: Document UUID class.

Tested with D2810.

dereckson added a commit: rKOTb14ea14ba504: Document UUID class.Mar 31 2023, 16:06

dereckson added a commit: rKOT09897d22e580: Document UUID class.Jun 19 2023, 23:14

Revision Contents
Changeset List

Path

Size

omnitools/

src/

Identifiers/

10 lines

Diff 6730

omnitools/src/Identifiers/UUID.php

Loading...