Skip to content

docs: add phpdoc summaries, examples, and docs links to resource classes#122

Open
tharropoulos wants to merge 21 commits into
typesense:masterfrom
tharropoulos:phpdocs
Open

docs: add phpdoc summaries, examples, and docs links to resource classes#122
tharropoulos wants to merge 21 commits into
typesense:masterfrom
tharropoulos:phpdocs

Conversation

@tharropoulos
Copy link
Copy Markdown
Collaborator

Change Summary

add phpdoc with one-line summaries, @example usage snippets, and @see docs links to every resource class in src/, mirroring the wording of the js client's jsdoc. hovering on $client->keys, $client->collections['products']->documents->import(...), etc. surfaces the right description, a runnable example, and a link to the relevant docs section. annotate the legacy analytics v1, synonyms, and synonym classes with @deprecated pointing to their replacements.

PR Checklist

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.

1 participant