-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
feat: new api documentation theme #2916
Conversation
2f7a256
to
c617259
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The following two traits would need to be updated since they are failing when being parsed by the new docs tool. The return type given there is incorrect for each one. Please see below:
- EncryptionTrait the return type should be array but is has
[AesStreamInterface, string]
. A descriptive message can be added to note the element types for that array. Example:
* @return array An array that returns two elements as follow [AesStreamInterface, string]
- EncryptionTraitV2 the return type should be AppendStream but it has also
@return [AesStreamInterface, string]
, and a return statement should be added at the end that handles when the condition in the switch statement is not met. Maybe return null.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be possible to have the search result windows pops up after hitting enter? It shows up by typing just a single letter.
afebed5
to
0bcc5ac
Compare
I have no idea what's happening with the encryption traits. I've updated the type annotations for the method, but it's still coming back with The search modal position has been adjusted so it appears under the search bar. I think it's fine to show results as the search is being typed. |
6ad343b
to
83cf4a7
Compare
Description of changes:
Updates API doc generation. Now using PHPDocumentor for generation with a few overrides to their theming.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.