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.

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

Template improvements #2208

Open
jaapio opened this issue Jan 11, 2020 · 0 comments
Open

Template improvements #2208

jaapio opened this issue Jan 11, 2020 · 0 comments

Comments

@jaapio
Copy link
Member

jaapio commented Jan 11, 2020

Just some notes from a first glance looking at the current output (I should probably open separate issues for these):

  • Everything inherited from a parent class is shown in every child class.
    For individual elements it will show "Inherited from" in the side bar on the right side, but there is no ordering by child class/ parent class or a way to hide what comes from the parent in the summary.
  • When something is clicked, the menu on the left folds in again. State doesn't pertain between screens. (usability)
  • Multiple class level @since tags are not parsed correctly.
    Example can be seen in: build/docs/output/classes/PHPCompatibility-Sniffs-FunctionDeclarations-NewParamTypeDeclarationsSniff.html
  • Class level @link tags do not show at all.
    Example can be seen in the same file as above.
  • Inline {@internal .. } tags are shown in plain text.
    Example can be seen in build/docs/output/classes/PHPCompatibility-Sniffs-FunctionDeclarations-ForbiddenParameterShadowSuperGlobalsSniff.html

There will probably be more, but I should have left half an hour ago already 😅 , so don't have time at the moment for a more detailed check

Originally posted by @jrfnl in #2130 (comment)

@jaapio jaapio added this to Needs triage in phpDoc issue triage board Jan 11, 2020
@jaapio jaapio moved this from Needs triage to To Do in phpDoc issue triage board Jan 11, 2020
@mvriel mvriel added this to In progress in Comference Hackathon Aug 21, 2020
@mvriel mvriel moved this from In progress to To do in Comference Hackathon Aug 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Development

No branches or pull requests

1 participant