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

feat: new api documentation theme #2916

Merged
merged 3 commits into from
May 29, 2024
Merged

Conversation

stobrien89
Copy link
Member

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.

@stobrien89 stobrien89 force-pushed the feat-make-api branch 2 times, most recently from 2f7a256 to c617259 Compare May 7, 2024 22:02
Copy link
Contributor

@yenfryherrerafeliz yenfryherrerafeliz left a 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.

Copy link
Contributor

@yenfryherrerafeliz yenfryherrerafeliz left a 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.

@stobrien89 stobrien89 force-pushed the feat-make-api branch 2 times, most recently from afebed5 to 0bcc5ac Compare May 13, 2024 21:13
@stobrien89
Copy link
Member Author

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 Unexpected token "[", expected type at offset 0 on line 1. Nothing appears to be wrong with either file.

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.

@stobrien89 stobrien89 merged commit 23d9748 into aws:master May 29, 2024
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants