Correct phpdocs of methods marked internal #5847

New Issue

admin · 2026-01-22T15:19:48+01:00

admin commented

2026-01-22 15:19:48 +01:00

Originally created by @egircys on GitHub (Jan 14, 2018).

Some methods have in their phpdocs the keyword "INTERNAL", as stated in the PR https://github.com/doctrine/doctrine2/pull/6967

e.g.
https://github.com/doctrine/doctrine2/blob/master/lib/Doctrine/ORM/UnitOfWork.php#L843
https://github.com/doctrine/doctrine2/blob/master/lib/Doctrine/ORM/PersistentCollection.php#L100

Internal can be a method or class, but also a part of the description text. https://docs.phpdoc.org/references/phpdoc/tags/internal.html

I believe it makes sense to update the phpdocs accordingly, in order to remove the ambiguity.

Originally created by @egircys on GitHub (Jan 14, 2018). Some methods have in their phpdocs the keyword "INTERNAL", as stated in the PR https://github.com/doctrine/doctrine2/pull/6967 e.g. https://github.com/doctrine/doctrine2/blob/master/lib/Doctrine/ORM/UnitOfWork.php#L843 https://github.com/doctrine/doctrine2/blob/master/lib/Doctrine/ORM/PersistentCollection.php#L100 Internal can be a method or class, but also a part of the description text. https://docs.phpdoc.org/references/phpdoc/tags/internal.html I believe it makes sense to update the phpdocs accordingly, in order to remove the ambiguity.

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: doctrine/archived-orm#5847