Joomla! Issue Tracker - Weblinks

Download
Launch
Feeling Lucky

[#339] - Using @link over @see

Failure

User tests: Successful: Unsuccessful:

avatar zero-24
zero-24
14 Apr 2017

Summary of Changes

using @link over @see

Testing Instructions

Review

avatar zero-24 zero-24 - open - 14 Apr 2017
avatar zero-24 zero-24 - change - 15 Apr 2017
Milestone Added: Weblinks 3.7.0
avatar astridx
astridx - comment - 15 Apr 2017

Why do you want to change this annotation? For what do we use the annotations?

I had a look to the description on phpDocumentor https://www.phpdoc.org:

The @see tag indicates a reference from the associated Structural Elements to a website or other Structural Elements.

And

The @link tag indicates a custom relation between associated Structural Elements and a website, which is identified by an absolute URI.

I am not sure, but I think "reference" fits better than "custom relation".

Apart of that: If we want to use phpDocumentor - should we add a description to the annotation?

avatar zero-24
zero-24 - comment - 15 Apr 2017

websites should use the @link tag ? @see is for something like a class or object to be checked

Example:

@see JControllerLegacy

and

@link https://joomla.org

Example warnings i got if we don't do it this way:

image

avatar alikon
alikon - comment - 16 Apr 2017

thanks for explanation, the same apply here
joomla/joomla-cms#15302

avatar yvesh yvesh - change - 21 Apr 2017
Status New ⇒ Fixed in Code Base
Closed_Date 0000-00-00 00:00:00 ⇒ 2017-04-21 17:25:51
Closed_By ⇒ yvesh
avatar yvesh yvesh - close - 21 Apr 2017
avatar yvesh yvesh - merge - 21 Apr 2017
avatar yvesh yvesh - reference | 02865f3 - 21 Apr 17
avatar yvesh yvesh - merge - 21 Apr 2017
avatar yvesh yvesh - close - 21 Apr 2017
avatar yvesh
yvesh - comment - 21 Apr 2017

Thank you @zero-24

avatar zero-24 zero-24 - head_ref_deleted - 21 Apr 2017
avatar zero-24
zero-24 - comment - 21 Apr 2017

Thanks !

Add a Comment

Login with GitHub to post a comment