--
You received this message because you are subscribed to the Google Groups "PHP Framework Interoperability Group" group.
To post to this group, send email to php...@googlegroups.com.
To unsubscribe from this group, send email to php-fig+u...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msg/php-fig/-/mzfTCfGqvogJ.
For more options, visit https://groups.google.com/groups/opt_out.
You can find the working draft in our repository:
https://github.com/phpDocumentor/phpDocumentor2/blob/develop/docs/PSR.md
Greetings.By my opinion, changes to or replacement to PHPDoc should not be made nor implemented by a single vendor, what phpDocumentator is.Crude example is already section 5.2 of particular PHPDocumentator PSR - it already suggests Markdown in long description, which will create "bloat" as it is currently with code documented in a way using HTML tags in a long description. Same with a code examples.
--
You received this message because you are subscribed to the Google Groups "PHP Framework Interoperability Group" group.
To post to this group, send email to php...@googlegroups.com.
To unsubscribe from this group, send email to php-fig+u...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msg/php-fig/-/M1oe0Tu5oZcJ.
--
You received this message because you are subscribed to the Google Groups "PHP Framework Interoperability Group" group.
To post to this group, send email to php...@googlegroups.com.
To unsubscribe from this group, send email to php-fig+u...@googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.
Regarding documenting option keys, maybe the documentation itself better fits into the long description? IMO there is some merrit in keeping the @param part short, so that you can get the allowed keys in a quick glance, and if you need more info because they are not self-explanatory and you don't know what they are doing yet, then you can take a look at the long description.
Another option might be to split the type definition and the description into two separate annotations which would keep the definition of what is available short, and also serve the need for a more structured documentation.
So, one more thing that just occurred to me: Nested hashes.
Some of us need to support nested hashes of options for one reason or another. How well would this scale for that case? Would the "inner" sections be able to recurse (potentially) infinitely (or until PHP blows a fuse)?