@see without description not working #1079

Closed
smcjones opened this Issue Nov 23, 2013 · 9 comments

Comments

Projects
None yet
7 participants

If I use @see className, nothing shows up.. I need to type @see className className for it to be effective.

Owner

mvriel commented Nov 23, 2013

Thank you fo reporting this issue; we will have to take a look why this occurs. Can you tell which template you used?

I used classic as well as Responsive.

-----Original Message-----
From: "Mike van Riel" notifications@github.com
Sent: ‎11/‎23/‎2013 12:43 PM
To: "phpDocumentor/phpDocumentor2" phpDocumentor2@noreply.github.com
Cc: "smcjones" smcjones@gmail.com
Subject: Re: [phpDocumentor2] @see without description not working (#1079)

Thank you fo reporting this issue; we will have to take a look why this occurs. Can you tell which template you used?

Reply to this email directly or view it on GitHub.

@siad007 siad007 referenced this issue in phpDocumentor/template.clean Nov 25, 2013

Open

Fixes see and uses issues #22

@mvriel mvriel modified the milestones: 2.4, 2.3 Feb 16, 2014

Pull request #22 fixed it for me in the clean template, responsive is still broken

@mvriel mvriel modified the milestones: 2.5, 2.4 Mar 30, 2014

@toxalot toxalot referenced this issue in phpDocumentor/template.clean Apr 6, 2014

Open

Missing URI | FQSEN and bad link for @see #28

toxalot commented Apr 6, 2014

I don't think that phpDocumentor/template.clean#22 is a complete fix. It only fixes some views for clean.

Also, Abstract also has a similar issue. It's missing the URI | FQSEN just like clean, but its link is broken in a different way.

The clean template links to current page with no fragment identifier. The abstract template links to files/ \URI | FQSEN

@mvriel mvriel modified the milestones: 2.6, 2.5 May 17, 2014

@mvriel mvriel modified the milestones: 2.7, 2.6 Jul 4, 2014

@mvriel mvriel added Template and removed Template labels Jul 9, 2014

Owner

mvriel commented Jul 9, 2014

I believe this issue is resolved in version 2.6; I want to test this again to be sure

@mvriel mvriel modified the milestones: 2.7, 2.8 Aug 30, 2014

@mvriel mvriel modified the milestones: 2.8, 2.8.2 Feb 18, 2015

fi5er commented Jan 22, 2016

I believe this issue is resolved in version 2.6; I want to test this again to be sure

@mvriel: Just checked, it's still there in 2.8.5 (tested "clean" and "responsive" templates).

@jaapio jaapio added the Template label May 17, 2016

@jaapio jaapio modified the milestones: 2.9.0, 2.10.0 May 22, 2016

@mbed67 mbed67 self-assigned this May 25, 2017

Collaborator

mbed67 commented May 29, 2017

I'm investigating the issue using this test file and the phpDocumentor2 code base. The phpDocumentor2 version is the latest master but using version 2.0.5 of phpdocumentor/reflection-docblock
TestSeeTagIssue.php.zip

Collaborator

mbed67 commented May 29, 2017

The results are as follows for templates responsive and clean:

namespace phpDocumentor\Descriptor;

use \phpDocumentor\Descriptor\Builder\AssemblerAbstract;

/**
 * Class to check if see tags are working correctly
 *
 * Inline relative class {@see AssemblerAbstract testClass relative} : responsive + clean ok
 * Inline relative class {@see AssemblerAbstract} : responsive + clean ok
 *
 * Inline absolute class {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract testClass absolute} : responsive + clean ok
 * Inline absolute class {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract} : responsive + clean ok
 *
 * Inline relative method {@see AssemblerAbstract::getBuilder() testMethod relative} : responsive + clean ok
 * Inline relative method {@see AssemblerAbstract::getBuilder()} : responsive + clean ok
 *
 * Inline absolute method {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder() testMethod absolute} : responsive + clean ok
 * Inline absolute method {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder()} : responsive + clean ok
 *
 * Inline relative property {@see AssemblerAbstract::$builder testProperty relative} : responsive + clean ok
 * Inline relative property {@see AssemblerAbstract::$builder} : responsive + clean ok
 *
 * Inline absolute property {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder testProperty absolute} : responsive + clean ok
 * Inline absolute property {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder} : responsive + clean ok
 *
 * Inline see to same class relative {@see TestSeeTagIssue} : responsive + clean ok
 * Inline see to same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue} : responsive + clean ok
 *
 * Inline see to same class relative {@see \phpDocumentor\Descriptor\TestSeeTagIssue class itself} : responsive + clean ok
 * Inline see to same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue class itself} : responsive + clean ok
 *
 * Inline see to property in same class relative {@see TestSeeTagIssue::$property} : responsive + clean ok
 * Inline see to property in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::$property} : responsive + clean ok
 *
 * Inline see to property in same class relative {@see TestSeeTagIssue::$property own property} : responsive + clean ok
 * Inline see to property in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::$property own property} : responsive + clean ok
 *
 * Inline see to method in same class relative {@see TestSeeTagIssue::method()} : responsive + clean ok
 * Inline see to method in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::method()} : responsive + clean ok
 *
 * Inline see to method in same class relative {@see TestSeeTagIssue::method() own method} : responsive + clean ok
 * Inline see to method in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::method() own method} : responsive + clean ok
 *
 * @see AssemblerAbstract : responsive wrong (no text, corrupt link), clean wrong (is linking to container class, text ok)
 * @see AssemblerAbstract with description : responsive wrong (corrupt link), clean wrong (is linking to container class, text ok)
 *
 * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract : responsive wrong (no text, corrupt link), clean ok
 * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract with description : responsive wrong (corrupt link), clean ok
 *
 * @see AssemblerAbstract::getBuilder() : responsive wrong (no text, corrupt link), clean ok
 * @see AssemblerAbstract::getBuilder() with description : responsive wrong (corrupt link), clean ok
 *
 * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder() : responsive wrong (no text, corrupt link), clean ok
 * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder() with description : responsive wrong (corrupt link), clean ok
 *
 * @see AssemblerAbstract::$builder : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
 * @see AssemblerAbstract::$builder with description : responsive wrong (corrupt link), clean ok
 *
 * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
 * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder with description : responsive wrong (corrupt link), clean ok
 *
 * @see TestSeeTagIssue : responsive wrong (no text, corrupt link), clean ok
 * @see TestSeeTagIssue class itself : responsive wrong (corrupt link), clean ok
 *
 * @see \phpDocumentor\Descriptor\TestSeeTagIssue : responsive wrong (no text, corrupt link), clean ok
 * @see \phpDocumentor\Descriptor\TestSeeTagIssue class itself : responsive wrong (corrupt link), clean ok
 *
 * @see TestSeeTagIssue::$property : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
 * @see TestSeeTagIssue::$property own property : responsive wrong (corrupt link), clean ok
 *
 * @see \phpDocumentor\Descriptor\TestSeeTagIssue::$property : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
 * @see \phpDocumentor\Descriptor\TestSeeTagIssue::$property own property : responsive wrong (corrupt link), clean ok
 *
 * @see TestSeeTagIssue::method() : responsive wrong (no text, corrupt link), clean ok
 * @see TestSeeTagIssue::method() own method : responsive wrong (corrupt link), clean ok
 *
 * @see \phpDocumentor\Descriptor\TestSeeTagIssue::method() : responsive wrong (no text, corrupt link), clean ok
 * @see \phpDocumentor\Descriptor\TestSeeTagIssue::method() own method : responsive wrong (corrupt link), clean ok
 */
class TestSeeTagIssue
{
    /**
     * Test property to check if see tags are working correctly
     *
     * Inline relative class {@see AssemblerAbstract testClass relative} : responsive + clean ok
     * Inline relative class {@see AssemblerAbstract} : responsive + clean ok
     *
     * Inline absolute class {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract testClass absolute} : responsive + clean ok
     * Inline absolute class {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract} : responsive + clean ok
     *
     * Inline relative method {@see AssemblerAbstract::getBuilder() testMethod relative} : responsive + clean ok
     * Inline relative method {@see AssemblerAbstract::getBuilder()} : responsive + clean ok
     *
     * Inline absolute method {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder() testMethod absolute} : responsive + clean ok
     * Inline absolute method {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder()} : responsive + clean ok
     *
     * Inline relative property {@see AssemblerAbstract::$builder testProperty relative} : responsive + clean ok
     * Inline relative property {@see AssemblerAbstract::$builder} : responsive + clean ok
     *
     * Inline absolute property {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder testProperty absolute} : responsive + clean ok
     * Inline absolute property {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder} : responsive + clean ok
     *
     * Inline see to same class relative {@see TestSeeTagIssue} : responsive + clean wrong (doesn't make a link, text is ok)
     * Inline see to same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue} : responsive + clean ok
     *
     * Inline see to same class relative {@see \phpDocumentor\Descriptor\TestSeeTagIssue class itself} : responsive + clean ok
     * Inline see to same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue class itself} : responsive + clean ok
     *
     * Inline see to property in same class relative {@see TestSeeTagIssue::$property} : responsive + clean wrong (doesn't make a link, text is ok)
     * Inline see to property in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::$property} : responsive + clean ok
     *
     * Inline see to property in same class relative {@see TestSeeTagIssue::$property own property} : responsive + clean wrong (doesn't make a link, text is ok)
     * Inline see to property in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::$property own property} : responsive + clean ok
     *
     * Inline see to method in same class relative {@see TestSeeTagIssue::method()} : responsive + clean wrong (doesn't make a link, text is ok)
     * Inline see to method in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::method()} : responsive ok
     *
     * Inline see to method in same class relative {@see TestSeeTagIssue::method() own method} : responsive + clean wrong (doesn't make a link, text is ok)
     * Inline see to method in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::method() own method} : responsive + clean ok
     *
     * @see AssemblerAbstract : responsive wrong (no text, corrupt link), clean wrong (is linking to container class, text ok)
     * @see AssemblerAbstract with description : responsive wrong (corrupt link), clean wrong (is linking to container class, text ok)
     *
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract : responsive wrong (no text, corrupt link), clean ok
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract with description : responsive wrong (corrupt link), clean ok
     *
     * @see AssemblerAbstract::getBuilder() : responsive wrong (no text, corrupt link), clean ok
     * @see AssemblerAbstract::getBuilder() with description : responsive wrong (corrupt link), clean ok
     *
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder() : responsive wrong (no text, corrupt link), clean ok
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder() with description : responsive wrong (corrupt link), clean ok
     *
     * @see AssemblerAbstract::$builder : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
     * @see AssemblerAbstract::$builder with description : responsive wrong (corrupt link), clean ok
     *
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder with description : responsive wrong (corrupt link), clean ok
     *
     * @see TestSeeTagIssue : responsive wrong (no text, corrupt link), clean ok
     * @see TestSeeTagIssue class itself : responsive wrong (corrupt link), clean ok
     *
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue : responsive wrong (no text, corrupt link), clean ok
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue class itself : responsive wrong (corrupt link), clean ok
     *
     * @see TestSeeTagIssue::$property : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
     * @see TestSeeTagIssue::$property own property : responsive wrong (corrupt link), clean ok
     *
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue::$property : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue::$property own property : responsive wrong (corrupt link), clean ok
     *
     * @see TestSeeTagIssue::method() : responsive wrong (no text, corrupt link), clean ok
     * @see TestSeeTagIssue::method() own method : responsive wrong (corrupt link), clean ok
     *
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue::method() : responsive wrong (no text, corrupt link), clean ok
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue::method() own method : responsive wrong (corrupt link), clean ok
     */
    protected $property;

    /**
     * Test method to check if see tags are working correctly
     *
     * Inline relative class {@see AssemblerAbstract testClass relative} : responsive + clean ok
     * Inline relative class {@see AssemblerAbstract} : responsive + clean ok
     *
     * Inline absolute class {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract testClass absolute} : responsive + clean ok
     * Inline absolute class {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract} : responsive + clean ok
     *
     * Inline relative method {@see AssemblerAbstract::getBuilder() testMethod relative} : responsive + clean ok
     * Inline relative method {@see AssemblerAbstract::getBuilder()} : responsive + clean ok
     *
     * Inline absolute method {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder() testMethod absolute} : responsive + clean ok
     * Inline absolute method {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder()} : responsive + clean ok
     *
     * Inline relative property {@see AssemblerAbstract::$builder testProperty relative} : responsive + clean ok
     * Inline relative property {@see AssemblerAbstract::$builder} : responsive + clean ok
     *
     * Inline absolute property {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder testProperty absolute} : responsive + clean ok
     * Inline absolute property {@see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder} : responsive + clean ok
     *
     * Inline see to same class relative {@see TestSeeTagIssue} : responsive + clean wrong (doesn't make a link, text is ok)
     * Inline see to same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue} : responsive + clean ok
     *
     * Inline see to same class relative {@see \phpDocumentor\Descriptor\TestSeeTagIssue class itself} : responsive + clean ok
     * Inline see to same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue class itself} : responsive + clean ok
     *
     * Inline see to property in same class relative {@see TestSeeTagIssue::$property} : responsive + clean wrong (doesn't make a link, text is ok)
     * Inline see to property in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::$property} : responsive + clean ok
     *
     * Inline see to property in same class relative {@see TestSeeTagIssue::$property own property} : responsive + clean wrong (doesn't make a link, text is ok)
     * Inline see to property in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::$property own property} : responsive + clean ok
     *
     * Inline see to method in same class relative {@see TestSeeTagIssue::method()} : responsive + clean wrong (doesn't make a link, text is ok)
     * Inline see to method in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::method()} : responsive + clean ok
     *
     * Inline see to method in same class relative {@see TestSeeTagIssue::method() own method} : responsive + clean wrong (doesn't make a link, text is ok)
     * Inline see to method in same class absolute {@see \phpDocumentor\Descriptor\TestSeeTagIssue::method() own method} : responsive + clean ok
     *
     * @see AssemblerAbstract : responsive wrong (no text, corrupt link), clean wrong (is linking to container class, text ok)
     * @see AssemblerAbstract with description : responsive wrong (corrupt link), clean wrong (is linking to container class, text ok)
     *
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract : responsive wrong (no text, corrupt link), clean ok
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract with description : responsive wrong (corrupt link), clean ok
     *
     * @see AssemblerAbstract::getBuilder() : responsive wrong (no text, corrupt link), clean ok
     * @see AssemblerAbstract::getBuilder() with description : responsive wrong (corrupt link), clean ok
     *
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder() : responsive wrong (no text, corrupt link), clean ok
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::getBuilder() with description : responsive wrong (corrupt link), clean ok
     *
     * @see AssemblerAbstract::$builder : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
     * @see AssemblerAbstract::$builder with description : responsive wrong (corrupt link), clean ok
     *
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
     * @see \phpDocumentor\Descriptor\Builder\AssemblerAbstract::$builder with description : responsive wrong (corrupt link), clean ok
     *
     * @see TestSeeTagIssue : responsive wrong (no text, corrupt link), clean ok
     * @see TestSeeTagIssue class itself : responsive wrong (corrupt link), clean ok
     *
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue : responsive wrong (no text, corrupt link), clean ok
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue class itself : responsive wrong (corrupt link), clean ok
     *
     * @see TestSeeTagIssue::$property : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
     * @see TestSeeTagIssue::$property own property : responsive wrong (corrupt link), clean ok
     *
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue::$property : responsive wrong (no text, corrupt link), clean works but missing $ sign in text
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue::$property own property : responsive wrong (corrupt link), clean ok
     *
     * @see TestSeeTagIssue::method() : responsive wrong (no text, corrupt link), clean ok
     * @see TestSeeTagIssue::method() own method : responsive wrong (corrupt link), clean ok
     *
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue::method() : responsive wrong (no text, corrupt link), clean ok
     * @see \phpDocumentor\Descriptor\TestSeeTagIssue::method() own method : responsive wrong (corrupt link), clean ok
     */
    public function method()
    {
        // body of method
    }
}
Collaborator

mbed67 commented Aug 30, 2017

This issue has been fixed.

@mbed67 mbed67 closed this Aug 30, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment