Opened 10 years ago
Closed 10 years ago
#30591 closed defect (bug) (fixed)
Convert nonstandard use of “(optional)” in @param DocBlocks
Reported by: | coffee2code | Owned by: | DrewAPicture |
---|---|---|---|
Milestone: | 4.1 | Priority: | low |
Severity: | normal | Version: | |
Component: | General | Keywords: | has-patch |
Focuses: | docs | Cc: |
Description
A number of @param DocBlock descriptions use "(optional)" to denote a parameter as being optional. Additionally, its use is inconsistent, sometimes appearing at the start of the parameter description and sometimes at the end.
The inline documentation standards require that an optional parameter should be denoted with "Optional." at the beginning of the description.
Attached patch corrects all existing occurrences of this nonstandard notation.
Since those doc lines were changing anyway, I also went ahead and made some very minor formatting tweaks to those modified lines and/or to immediately adjacent lines. This includes: adding ending period for descriptions, stating the default value if not done so, correcting the way some default values were stated, aligning @param elements, and a few text fixes.
Patch mentioned in ticket description.