How to view API comments and documentation in Express Android SDK?

Since the Zego Express Android Java SDK is provided in the form of ".jar" and ".so", by default when you click to jump to an SDK class or function in Android Studio, it displays decompiled Java bytecode without comments.

To improve the development experience, starting from version v2.23.0, Java source code is provided in jar package form. Developers can import the source code jar package through Android Studio to obtain API comments.

Operation Guide

1. Download the latest Android SDK package from the official website.
2. After decompression, you can see a "ZegoExpressEngine-sources.jar" in the directory where "ZegoExpressEngine.jar" is located.

3. Open your project in Android Studio and open the source code file containing calls to "ZegoExpressEngine" related APIs. Click on the SDK class or function to jump, and you can see the Java bytecode decompiled by Android Studio.
4. At this point, you can click "Choose Sources..." in the upper right corner of the page. In the file selection window that pops up, find "ZegoExpressEngine-sources.jar" and open it.

5. After loading is complete, you can see that the previously decompiled Java bytecode is now source code with API comment documentation.

6. Now go back to your project source code file, hover your mouse over any SDK class or function, and you can display the documentation for this API.

6. (Optional) The SDK package also includes "javadoc" API documentation. You can find the "index.html" document in the "Document" directory of the decompressed SDK package. Double-click to open "index.html" to view the API documentation for this SDK package.