[#24745] - Change doc blocks for constants to use var tags
- Fixed in Code Base
- 28 Apr 2019
- Medium
- Build: staging
- # 24745
- Diff
- mbabker:const-api-docs
- Pending Hound Hound is busy sniffing around... Details
User tests: Successful: Unsuccessful:
Summary of Changes
The APIs that phpDocumentor uses to parse doc blocks has special handling for certain tags (@param, @property, @property-read, @property-write, and @var) to extract type information from the tag if properly structured, otherwise all of the text is considered as part of a description (or depending on the tag type some other internal properties that we aren't going to get into here unless you really want to learn the internals of phpDocumentor's doc block parsing libraries). So this pull request changes the doc blocks for constants in the API from @const tags to @var tags so that the type information is correctly extracted by the API. Additional minor PHPCS tweaks are made in affected doc blocks as well to conform to suggested structure or add descriptions where they didn't previously exist.
Testing Instructions
Code review; the changes made here are only going to impact the resulting output for https://api.joomla.org
| Status | New | ⇒ | Pending |
joomla-cms-bot
- | Category | ⇒ | Libraries Front End Plugins |
| Status | Pending | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2019-04-28 07:36:17 |
| Closed_By | ⇒ | zero-24 | |
| Labels |
Added:
?
|
||
Merging on review. thank you @mbabker