Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Inline @see and @link tags not working #1213

Closed
mvriel opened this issue Apr 7, 2014 · 10 comments
Closed

Inline @see and @link tags not working #1213

mvriel opened this issue Apr 7, 2014 · 10 comments
Assignees
@mvriel
Labels
bug
Milestone
2.6

Comments

@mvriel
Copy link
Member

mvriel commented Apr 7, 2014

@FlorianWolters wrote:

Neither inline @see nor inline @link are working with the responsive template in v2.4.0. The documentation states:

The effects of the inline version of this [@link] tag are not yet fully implemented in PhpDocumentor2. There’s only URI support (i.e. no support for Structural Elements), and even that is available only in long descriptions. This is a known issue that is sure to be fixed before the final release of PhpDocumentor 2.0.

So I would recommend to re-open this issue. A simple {@see ClassName} isn't rendered in the output.
@mvriel mvriel added this to the 2.5 milestone Apr 7, 2014
@mvriel mvriel added the Bug label Apr 7, 2014
@mvriel mvriel modified the milestones: 2.6, 2.5 May 17, 2014
@mvriel mvriel assigned mvriel and unassigned mvriel May 19, 2014
@mvriel mvriel assigned mvriel and unassigned mvriel Jun 5, 2014
@mvriel mvriel mentioned this issue Jun 6, 2014
Closed
mvriel added a commit to mvriel/phpDocumentor2 that referenced this issue Jun 6, 2014
@mvriel
phpDocumentor#1213: Resolve @see and @link to Markdown link
9f59f15 
In descriptions it is allowed to use the @see and @link tags; these tags
provide a link to a URL or other element in the project. In this commit
I have added a compiler pass that visits every description and replaces
the `@see` and `@link` tag with a Markdown-formatted link to that URL
or href.

I have chosen for a compiler pass because the transformer is the only
part that really knows the URLs for Descriptors and has a list of all
elements that are documented in the current project.
@mvriel
Copy link
Member Author

mvriel commented Jun 6, 2014

This issue is resolved with PR #1314, and will be released with version 2.6

@mvriel mvriel closed this as completed Jun 6, 2014
mvriel added a commit to mvriel/phpDocumentor2 that referenced this issue Jun 6, 2014
@mvriel
phpDocumentor#1213: The var_dump is a lie
58ac9ef
ashnazg added a commit that referenced this issue Jun 6, 2014
@ashnazg
Merge pull request #1314 from mvriel/feature/1213
698a82e 
#1213: Resolve @see and @link to Markdown link
@yoosefi
Copy link

yoosefi commented Sep 22, 2014

This is still not working :(

@mvriel
Copy link
Member Author

mvriel commented Sep 22, 2014

@yoosefi can you please open a new issue with your phpDocumentor version, method of installation and an example of what you tried and what you expected? Then we can investigate the issue. Thank you!

@yoosefi
Copy link

yoosefi commented Sep 22, 2014

I see now that it was because they were in summary locations. (#710 not a bug)

Thanks for the quick reply!

@mvriel
Copy link
Member Author

mvriel commented Sep 22, 2014

Happy to be of help! Thank you for letting us know

@ksimka
Copy link

ksimka commented Jan 27, 2015

According to this issue 'see' tag has inline syntax, but there's nothing about this feature in docs http://www.phpdoc.org/docs/latest/references/phpdoc/tags/see.html

If I get it right, guys from the PhpStorm team are still waiting for official docs to support inline 'see' tag — https://youtrack.jetbrains.com/issue/WI-24525 . So could you please update the docs so we can force those guys to implement inline 'see'?)

@Flexo013
Copy link

Flexo013 commented Oct 4, 2019

@mvriel
Giving this another bump as inline {@see ...} should really just work as it does in the description.

@yoosefi
Copy link

yoosefi commented Feb 21, 2020

I have to agree with @Flexo013 , inline should work regardless of where it appears (summary or not).

@jaapio
Copy link
Member

jaapio commented Feb 21, 2020

Please note that you are replying on a issue that has been closed for years, and reported on phpdocumentor v2.6 which is not maintained anymore.
I would highly recommend you to give the v3-rc a try, and open a new issue if the issue is still present. So we can have a look when needed.

@thebigb
Copy link

thebigb commented Mar 16, 2020

Can confirm this is still an issue with v3.0.0-rc.

adriendupuis pushed a commit to ibexa/core that referenced this issue Apr 7, 2023
SearchResultAdapter.php: Fix @see vs @link usage
0bd5d70 
Should have worked with inline @see tag according to https://docs.phpdoc.org/3.3/guide/references/phpdoc/tags/see.html#see but phpDocumentor may have difficulty with the inline version of @see phpDocumentor/phpDocumentor#1213 (comment)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mvriel mvriel

Labels
bug
Projects
None yet
Milestone
2.6
Development

No branches or pull requests
6 participants
@mvriel @jaapio @ksimka @yoosefi @thebigb @Flexo013