-
Notifications
You must be signed in to change notification settings - Fork 821
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
[ORM] API Documentation - Missing method parameters #7880
Comments
Could be an issue with the generator, or docblock format, unsure. Advised the creation of an issue rather than a PR due to unknown cause. |
Thanks for reporting. I suspect it's a syntax issue, as you mentioned. The It looks a little iffy about how to declare this with variadic arguments across multiple PHP versions (SS3 supports PHP 5.3) so I'm not sure what the solution is. You could test a few things out locally by installing the API site and running a build in a few different contexts to see. |
I've triaged this as a bug since we're incorrectly using PHPDoc. Will spend a bit of time now going through some instances of doc blocks in 3.6 |
fixed by #7994? @robbieaverill |
I’m not sure, that PR was a whip over to fix up some of the phpdocs but I didn’t have time to do all of them |
Still an issue, just checked |
Affected Version
Silverstripe 3.6 API Docs
Silverstripe 4.x API Docs
Description
When using the API documentation (for SS 3), I noticed that some methods are missing parameters. For example the DataList's sort() method. This method has the following DocBlocks
framework/model/DataList.php Line 283-296
But when you look at DataList's sort method
in the docs you will see that no Parameters (or examples) are listed.
Now I'm not sure if this is a DocBlock syntax issue or what, but when I brought it up on slack I was asked to create an issue for it. So uh, here it is.
Steps to Reproduce
If you travel to the API documentation for DataList's sort method you will see that the sort() method has no parameters listed even though the methods DocBlocks have one listed.
The text was updated successfully, but these errors were encountered: