phpDocumentor / phpDocumentor/ReflectionDocBlock

InvalidTag name with leading @

Open
#449 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
9.4k
Forks
137
Avg merge
4d 2h
Merged PRs (30d)
1

Description

For InvalidTag the getName() method sometimes returns the tag name including the @ - this is only happens for some cases and also only for InvalidTag.

When testing a tool on an lib, I got that for:

$foo = 'bar'; /** @var $self SomeClass */

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with InvalidTag::getName() and reproduce the behavior using the provided PHP docblock containing @var. Compare the affected cases with cases where the name is returned without @; done means the behavior is covered by a regression test and the returned invalid-tag name is consistent.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.