Support PHP enumerations #40
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support for PHP enumerations.
In general, the
:php:enum:and:php:case:directives work just like:php:class:and:php:const:, respectively. However, to support backed enums, I got a little creative and introduced a minor new syntax to the signature line.Here's a very simple, basic enum example:
Here's the same example as a backed enum:
This new syntax is effectively the same as this:
The use of
() ->, however, is intended to convey method parameters and a return type, which isn't appropriate semantics for a backed enum type and case values, so I decided to introduce this new syntax.When it renders, Sphinx displays it with the arrow symbol (→) as if it is a return type, but we don't have much choice, since we must use one of the methods from
sphinx.addnodes, and I chose to usedesc_returns().