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

Docs: improvements for better rendering in PHPDocumentor #153

Merged
merged 1 commit into from
Jun 13, 2020

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Jun 13, 2020

  • Remove markdown from DocBlock summaries as it's not supported.
  • Add backticks around inline code elements in long descriptions and tag descriptions.
  • Add markdown where relevant in long descriptions and tag descriptions to improve readability of the rendered output.
  • Add inline {@see ...} tags to create links to other documented elements.
  • Add inline {@link ...} tags.
  • Replace <code> tags with code block syntax.
  • Lower the amount of indentation used in code blocks for more readable rendering.
  • Replace singular backticks for multi-line code blocks with triple backticks, to allow for rendering as a proper code block instead of inline.
  • Replace some semi-lists with list syntax supported via markdown for better rendering.
  • Replace some list like return value array definitions with code blocks for better rendering.
  • Make some "Note:" remarks use blockquote syntax to draw more attention to them.
  • Use uppercase true/false/null in @return tags to make them more easily readable at a glance.

* Remove markdown from DocBlock summaries as it's not supported.
* Add backticks around inline code elements in long descriptions and tag descriptions.
* Add markdown where relevant in long descriptions and tag descriptions to improve readability of the rendered output.
* Add inline `{@see ...}` tags to create links to other documented elements.
* Add inline `{@link ...}` tags.
* Replace `<code>` tags with code block syntax.
* Lower the amount of indentation used in code blocks for more readable rendering.
* Replace singular backticks for multi-line code blocks with triple backticks, to allow for rendering as a proper code block instead of inline.
* Replace some semi-lists with list syntax supported via markdown for better rendering.
* Replace some list like return value array definitions with code blocks for better rendering.
* Make some "Note:"  remarks use blockquote syntax to draw more attention to them.
* Use uppercase true/false/null in `@return` tags to make them more easily readable at a glance.
@jrfnl jrfnl added this to the 1.0.0-alpha3 milestone Jun 13, 2020
@jrfnl jrfnl merged commit 440af70 into develop Jun 13, 2020
@jrfnl jrfnl deleted the docs/phpdoc-rendering-improvements branch June 13, 2020 21:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant