search

turms-im / turms

🕊️ The world's most advanced open source instant messaging engine for 100K~10M concurrent users https://turms-im.github.io/docs
Apache License 2.0
1.78k stars 280 forks source link

How to use the client API doc generator #1565

Open zhanchen18 opened 2 weeks ago

zhanchen18 commented 2 weeks ago

https://github.com/turms-im/turms/issues/1387 How to use the client API doc generator？I am just planning to generate the client-dart API doc.

JamesChenX commented 2 weeks ago
  1. Add any new methods with API docs on the service classes (e.g. UserService) turms-client-kotlin.
  2. 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
  3. Copy the generated API docs you want manually in ./generated-docs to the source code of client SDKs.
  4. Commit the changes.