No Code Attached Yet
avatar brianteeman
brianteeman
16 Jul 2023

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

  1. @link is to display a hyperlink to a URL and it should be @see
  2. JFilterInput should be InputFilter
  3. when there is no use statement for this then the fqn must be used or it simply doesnt work which as we now remove unuse use statements might have increased.
  4. afaict @see only works when it is on a new line

There 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()
avatar brianteeman brianteeman - open - 16 Jul 2023
avatar joomla-cms-bot joomla-cms-bot - change - 16 Jul 2023
Labels Added: No Code Attached Yet
avatar joomla-cms-bot joomla-cms-bot - labeled - 16 Jul 2023
avatar HLeithner
HLeithner - comment - 17 Jul 2023

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.

avatar brianteeman
brianteeman - comment - 17 Jul 2023

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

avatar brianteeman brianteeman - change - 24 Mar 2024
Status New Closed
Closed_Date 0000-00-00 00:00:00 2024-03-24 18:38:20
Closed_By brianteeman
avatar brianteeman brianteeman - close - 24 Mar 2024
avatar brianteeman
brianteeman - comment - 24 Mar 2024

closed - looks like i did this

Add a Comment

Login with GitHub to post a comment