[PR #528] [MERGED] Documentation fixes #8335

Closed
opened 2026-01-22 15:59:26 +01:00 by admin · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/doctrine/orm/pull/528
Author: @BenMorel
Created: 12/1/2012
Status: Merged
Merged: 12/23/2012
Merged by: @beberlei

Base: masterHead: master


📝 Commits (10+)

  • dacdd6c Documentation (docblock) fixes.
  • fad22d1 Fixed documentation for ORM\Event and ORM\Id
  • 4714a53 Fixed documentation for ORM\Internal
  • 46e6ada Fixed documentation for ORM\Mapping
  • 159ece8 Fixed documentation for ORM\Persisters
  • 43b301f Fixed English mistakes
  • 42e83a2 Fixed documentation for ORM\Proxy
  • f743da0 Fixed documentation for Doctrine\ORM\Query\AST\Functions
  • 98ac6b5 Fixed documentation for Doctrine\ORM\Query\AST
  • d435780 Fixed documentation for Doctrine\ORM\Query\Exec

📊 Changes

284 files changed (+6319 additions, -2423 deletions)

View changed files

📝 lib/Doctrine/ORM/AbstractQuery.php (+71 -26)
📝 lib/Doctrine/ORM/Configuration.php (+107 -35)
📝 lib/Doctrine/ORM/EntityManager.php (+92 -22)
📝 lib/Doctrine/ORM/EntityNotFoundException.php (+3 -0)
📝 lib/Doctrine/ORM/EntityRepository.php (+26 -14)
📝 lib/Doctrine/ORM/Event/LifecycleEventArgs.php (+5 -5)
📝 lib/Doctrine/ORM/Event/LoadClassMetadataEventArgs.php (+4 -5)
📝 lib/Doctrine/ORM/Event/OnClearEventArgs.php (+4 -4)
📝 lib/Doctrine/ORM/Event/PostFlushEventArgs.php (+1 -1)
📝 lib/Doctrine/ORM/Event/PreFlushEventArgs.php (+5 -0)
📝 lib/Doctrine/ORM/Event/PreUpdateEventArgs.php (+22 -13)
📝 lib/Doctrine/ORM/Events.php (+14 -1)
📝 lib/Doctrine/ORM/Id/AbstractIdGenerator.php (+2 -0)
📝 lib/Doctrine/ORM/Id/AssignedGenerator.php (+6 -1)
📝 lib/Doctrine/ORM/Id/IdentityGenerator.php (+10 -4)
📝 lib/Doctrine/ORM/Id/SequenceGenerator.php (+35 -6)
📝 lib/Doctrine/ORM/Id/TableGenerator.php (+27 -0)
📝 lib/Doctrine/ORM/Id/UuidGenerator.php (+4 -5)
📝 lib/Doctrine/ORM/Internal/CommitOrderCalculator.php (+39 -1)
📝 lib/Doctrine/ORM/Internal/Hydration/AbstractHydrator.php (+66 -20)

...and 80 more files

📄 Description

This is a first batch of documentation fixes:

  • Missing docblocks
  • Missing / incorrect @param / @return / @throws annotations
  • Missing newlines between annotations
  • Incorrect vertical alignment of @param annotations

I'm willing to make more documentation fixes on this project, but I'll wait for your feedback on this first batch before moving forward!

Let me know if you have any comment / suggestion / question.


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/doctrine/orm/pull/528 **Author:** [@BenMorel](https://github.com/BenMorel) **Created:** 12/1/2012 **Status:** ✅ Merged **Merged:** 12/23/2012 **Merged by:** [@beberlei](https://github.com/beberlei) **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (10+) - [`dacdd6c`](https://github.com/doctrine/orm/commit/dacdd6cd898f9226104f51861f8ed4d240b83959) Documentation (docblock) fixes. - [`fad22d1`](https://github.com/doctrine/orm/commit/fad22d1e60d866ea974718dee2b6d51febb8c34b) Fixed documentation for ORM\Event and ORM\Id - [`4714a53`](https://github.com/doctrine/orm/commit/4714a53c323d62c3602136bd4632d6ddcef18a94) Fixed documentation for ORM\Internal - [`46e6ada`](https://github.com/doctrine/orm/commit/46e6ada4f98b0f3d2bf12329ca7a460f393a2700) Fixed documentation for ORM\Mapping - [`159ece8`](https://github.com/doctrine/orm/commit/159ece894321764e79d64cac1d9c806717684cf2) Fixed documentation for ORM\Persisters - [`43b301f`](https://github.com/doctrine/orm/commit/43b301f22b6a8ba2fe0fa6c0493cc2283376acd7) Fixed English mistakes - [`42e83a2`](https://github.com/doctrine/orm/commit/42e83a2716d19eada4f1cd49ece77d5f5229a239) Fixed documentation for ORM\Proxy - [`f743da0`](https://github.com/doctrine/orm/commit/f743da0e02a7c6c6087495084bfc08a9a539f2af) Fixed documentation for Doctrine\ORM\Query\AST\Functions - [`98ac6b5`](https://github.com/doctrine/orm/commit/98ac6b5fecde73ee18c9b813c88ecb75f4b706db) Fixed documentation for Doctrine\ORM\Query\AST - [`d435780`](https://github.com/doctrine/orm/commit/d4357801a2fbbcdf5ef3b6d4fd435430b7a68714) Fixed documentation for Doctrine\ORM\Query\Exec ### 📊 Changes **284 files changed** (+6319 additions, -2423 deletions) <details> <summary>View changed files</summary> 📝 `lib/Doctrine/ORM/AbstractQuery.php` (+71 -26) 📝 `lib/Doctrine/ORM/Configuration.php` (+107 -35) 📝 `lib/Doctrine/ORM/EntityManager.php` (+92 -22) 📝 `lib/Doctrine/ORM/EntityNotFoundException.php` (+3 -0) 📝 `lib/Doctrine/ORM/EntityRepository.php` (+26 -14) 📝 `lib/Doctrine/ORM/Event/LifecycleEventArgs.php` (+5 -5) 📝 `lib/Doctrine/ORM/Event/LoadClassMetadataEventArgs.php` (+4 -5) 📝 `lib/Doctrine/ORM/Event/OnClearEventArgs.php` (+4 -4) 📝 `lib/Doctrine/ORM/Event/PostFlushEventArgs.php` (+1 -1) 📝 `lib/Doctrine/ORM/Event/PreFlushEventArgs.php` (+5 -0) 📝 `lib/Doctrine/ORM/Event/PreUpdateEventArgs.php` (+22 -13) 📝 `lib/Doctrine/ORM/Events.php` (+14 -1) 📝 `lib/Doctrine/ORM/Id/AbstractIdGenerator.php` (+2 -0) 📝 `lib/Doctrine/ORM/Id/AssignedGenerator.php` (+6 -1) 📝 `lib/Doctrine/ORM/Id/IdentityGenerator.php` (+10 -4) 📝 `lib/Doctrine/ORM/Id/SequenceGenerator.php` (+35 -6) 📝 `lib/Doctrine/ORM/Id/TableGenerator.php` (+27 -0) 📝 `lib/Doctrine/ORM/Id/UuidGenerator.php` (+4 -5) 📝 `lib/Doctrine/ORM/Internal/CommitOrderCalculator.php` (+39 -1) 📝 `lib/Doctrine/ORM/Internal/Hydration/AbstractHydrator.php` (+66 -20) _...and 80 more files_ </details> ### 📄 Description This is a first batch of documentation fixes: - Missing docblocks - Missing / incorrect `@param` / `@return` / `@throws` annotations - Missing newlines between annotations - Incorrect vertical alignment of `@param` annotations I'm willing to make more documentation fixes on this project, but I'll wait for your feedback on this first batch before moving forward! Let me know if you have any comment / suggestion / question. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
admin added the pull-request label 2026-01-22 15:59:26 +01:00
admin closed this issue 2026-01-22 15:59:26 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: doctrine/archived-orm#8335