As an example
There are 27 identical uses of @link \JFilterInput::clean()
plus about 100 more variants
From my understanding this is wrong on at least 2 counts
@link
is to display a hyperlink to a URL and it should be @see
JFilterInput
should be InputFilter
@see
only works when it is on a new lineThere is no point in having docs if they are not correct so I propose that these @link
are updated as above and while it might not always be necessary to use the fqn it would make it more consistent
So this would make
* @param array $urlparams An array of safe url parameters and their variable types, for valid values see {@link \JFilterInput::clean()}.
* @param array $urlparams An array of safe url parameters and their variable types, for valid values
* @see \Joomla\CMS\Filter\InputFilter::clean()
Labels |
Added:
No Code Attached Yet
|
Thanks for the reply. Next time I have a few moments (or cant sleep) I will take a pass at resolving some of these. Probably will do it in smaller Pr so its easier to review that a single monster pr
Status | New | ⇒ | Closed |
Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2024-03-24 18:38:20 |
Closed_By | ⇒ | brianteeman |
closed - looks like i did this
Since most of the occourence is in the
Controller::display
function which actually inherit the documentation of the base class, the question is if we should continue to keep the duplicated documentation or let the ide and phpdocumentor do this for us.About the points.
1+4. yes make sense
2. Yes more or less al J-Prefixes have to be changed
3. normally the tools detecting unused
use
statements also understand that they are used in the docblocks.