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 suggestion: ordering of function doc sub-sections #2456

Open
jrfnl opened this issue Jun 17, 2020 · 0 comments
Open

Template suggestion: ordering of function doc sub-sections #2456

jrfnl opened this issue Jun 17, 2020 · 0 comments

Comments

@jrfnl
Copy link
Contributor

jrfnl commented Jun 17, 2020

Template issue/request

This is just a suggestion. I know I will be able to overload specific partial template layouts myself to handle this for the documentation I'm working on, but I figured I'd open an issue to discuss this, just in case other people may think this could be a good idea as well.

Ok, so, currently the method docblock is ordered like this:

  1. Summary
  2. Signature
  3. Description
  4. Parameters
  5. Tags
  6. Return values

issue-2456

Now, in case there are several arbitrary tags, this moves the "Return" section quite far down from the parameters and the function signature, making these feel disconnected.

Aside from that, while not strictly a return value, the exceptions thrown are shown under "Tags", while to me it would make more sense to show them either in a separate block section or in a sub-section of the "Return" section.

So, I was wondering how people would feel about a re-ordering like this:
issue-2456-proposed

Opinions ?

@jaapio jaapio added this to Needs triage in phpDoc issue triage board Jun 17, 2020
jrfnl added a commit to jrfnl/phpDocumentor-issue-demo that referenced this issue Jun 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
phpDoc issue triage board
  
Needs triage
Development

No branches or pull requests

2 participants