phpDocumentor / phpDocumentor/phpDocumentor
XML template leads to empty @see tags
Open
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 4.3k
- Forks
- 648
- Avg merge
- 28m
- Merged PRs (30d)
- 13
Description
* This class is created internally by {@see Google\Cloud\Vision\Annotation} and is used to represent various
* annotation feature results.
Leads to this with the XML template:
This class is created internally by {@see} and is used to represent various
annotation feature results.
It works with the default template:
<section class="phpdocumentor-description"><p>This class is created internally by <abbr title="\Google\Cloud\Vision\Annotation\Google\Cloud\Vision\Annotation">Annotation</abbr> and is used to represent various
annotation feature results.</p>
Is there a way to make the XML template include the @see tag? It works for some other tags, but many of them are missing.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the XML template and its handling of the @see tag, then compare the result with the default template using the Entity.php example in the issue. Reproduce the empty-tag output and trace how other tags are rendered. Done means the XML output includes the referenced class for this @see tag and existing template behavior remains intact.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100