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.

Sign up for GitHub

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

Jump to bottom

How to use the client API doc generator #1565

Open

zhanchen18 opened this issue Nov 1, 2024 · 1 comment

Labels

documentation enhancement

zhanchen18 commented Nov 1, 2024

#1387
How to use the client API doc generator？I am just planning to generate the client-dart API doc.

JamesChenX added documentation enhancement labels

Member

JamesChenX commented Nov 4, 2024

Add any new methods with API docs on the service classes (e.g. UserService) turms-client-kotlin.
Install Node.js and run node ./tools/generate-client-api-comments.js in the root dir of turms repo, which will generate API docs based on the API docs of turms-client-kotlin for turms-client-cpp/dart/swift/typescript
Copy the generated API docs you want manually in ./generated-docs to the source code of client SDKs.
Commit the changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment