Smart-doc is a java restful api document generation tool. Smart-doc is based on interface source code analysis to generate interface documentation, completely zero-injection.
This commit significantly enhances the functionality of the WebSocket documentation generator by introducing support for message parameters and response parameters, enabling the generated documentation to more accurately reflect the details of WebSocket interfaces. The changes include, but are not limited to, the following:
Introduced handling of the @OnMessage annotation, allowing documentation to include message parameters.
Added extraction and display of response parameters, enabling the documentation to show the return structure of the interface.
Updated the documentation template to support the newly introduced features.
Optimized the extraction logic for WebSocket path parameters, making the parameter list in the documentation more accurate.
These changes significantly improve the utility and flexibility of the documentation generator, making the generated content more comprehensive and helping users better understand and use WebSocket interfaces.
This commit significantly enhances the functionality of the WebSocket documentation generator by introducing support for message parameters and response parameters, enabling the generated documentation to more accurately reflect the details of WebSocket interfaces. The changes include, but are not limited to, the following:
@OnMessageannotation, allowing documentation to include message parameters.These changes significantly improve the utility and flexibility of the documentation generator, making the generated content more comprehensive and helping users better understand and use WebSocket interfaces.
see discussions #874