Feeling Lucky
PR-5.0-dev
[#41178] - [5.0] @link docblock
- Fixed in Code Base
- 9 Aug 2023
- Medium
- Build: 5.0-dev
- # 41178
- Diff
- brianteeman:docsee
User tests: Successful: Unsuccessful:
@linkis to display a hyperlink to a URL and it should be@seeJFilterInputshould beInputFilter- 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.
- afaict
@seeonly 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.
Code Review
joomla-cms-bot
- | Category | ⇒ | Administration com_admin com_banners com_categories com_checkin com_contact com_cpanel com_finder com_installer com_joomlaupdate com_languages com_login com_menus com_messages com_newsfeeds com_plugins com_redirect com_tags com_templates Front End |
| Status | New | ⇒ | Pending |
| Category | Administration com_admin com_banners com_categories com_checkin com_contact com_cpanel com_finder com_installer com_joomlaupdate com_languages com_login com_menus com_messages com_newsfeeds com_plugins com_redirect com_tags com_templates Front End | ⇒ | Administration com_admin com_banners com_categories com_checkin com_config com_contact com_cpanel com_finder com_installer com_joomlaupdate com_languages com_login com_menus com_messages com_newsfeeds com_plugins com_redirect com_tags com_templates Front End Libraries |
| Labels |
Added:
PR-5.0-dev
|
||
| Category | Administration com_admin com_banners com_categories com_checkin com_contact com_cpanel com_finder com_installer com_joomlaupdate com_languages com_login com_menus com_messages com_newsfeeds com_plugins com_redirect com_tags com_templates Front End com_config Libraries | ⇒ | Administration com_admin com_banners com_categories com_checkin com_config com_contact com_content com_cpanel com_fields com_finder com_installer com_joomlaupdate com_languages com_login com_menus com_messages com_modules com_newsfeeds com_plugins com_redirect com_tags com_templates |
| Category | Administration com_admin com_banners com_categories com_checkin com_contact com_cpanel com_finder com_installer com_joomlaupdate com_languages com_login com_menus com_messages com_newsfeeds com_plugins com_redirect com_tags com_templates com_config com_content com_fields com_modules | ⇒ | Administration com_admin com_banners com_categories com_checkin com_config com_contact com_content com_cpanel com_fields com_finder com_installer com_joomlaupdate com_languages com_login com_menus com_messages com_modules com_newsfeeds com_plugins |
brianteeman
- comment
- 17 Jul 2023
ok I can move it back to be a single line - or more likely a nested line so it isnt too long.
* @param array $urlparams An array of safe URL parameters and their variable types.
* @see \Joomla\CMS\Filter\InputFilter::clean() for valid values.
is that better for you.
wilsonge
- comment
- 17 Jul 2023
If it works I'd prefer that. Not quite sure what's the difference between the phpdocumentor docs and what's rendering right now to be honest.
| Status | Pending | ⇒ | Fixed in Code Base |
| Closed_Date | 0000-00-00 00:00:00 | ⇒ | 2023-08-09 20:34:16 |
| Closed_By | ⇒ | HLeithner |
HLeithner
- comment
- 9 Aug 2023
I merge this for now and hope this works better for phpdocumentor, thanks
https://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.inlinelink.pkg.html the inline link is documented as working with other functions. Obviously it's not properly parsing in the API docs either https://api.joomla.org/cms-4/classes/Joomla-CMS-Application-CMSWebApplicationInterface.html#method_getUserStateFromRequest so maybe the FQDN is the missing part? By having it on a separate line it now is a function level
@seerather than a parameter level one so the change here isn't ideal.