phpDocumentor / phpDocumentor/ReflectionDocBlock
Support Annotation-style tags
Nobody has claimed this yet.
- Dominant language
- PHP
- Stars
- 9.4k
- Forks
- 137
- Avg merge
- 4d 2h
- Merged PRs (30d)
- 1
Description
Tags like @Route("/anonymization_preset", name="anonymization_preset_") show the part between parenthesis as part of the description. It would be more convenient to make this a first-class citizen as now this conflicts with the rule that descriptions may be parsed as Markdown documents.
See https://github.com/phpDocumentor/phpDocumentor/issues/2081 for more information
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 by reading this issue and the linked phpDocumentor issue 2081 to clarify the intended Annotation-style tag syntax and how it should differ from Markdown descriptions. Then locate the tag parsing and description handling entry points in ReflectionDocBlock; done means the example annotation is treated as a first-class tag without being parsed as part of the description, with coverage for the new behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100