A tool for generating well polished and developer friendly API documentation(openAPI spec 3.0.0) directly from source code with LLM
This project represents the practical application of our extensive research studies. It is essential to emphasize that this is a research project and is expressly NOT intended for use in production environments. The focus of this endeavor is to explore, experiment, and advance knowledge within a controlled research context. We appreciate your understanding and cooperation in this regard.
Should be in the format:
Describe specific features of your extension including screenshots of your extension in action. Image paths are relative to this README file.
For example if there is an image subfolder under your extension project workspace:
If you have any requirements or dependencies, add a section describing those and how to install and configure them.
Include if your extension adds any VS Code settings through the
This extension contributes the following settings:
Calling out known issues can help limit users opening duplicate issues against your extension.
Users appreciate release notes as you update your extension.
Initial release of ...
Fixed issue #.
Added features X, Y, and Z.
Following extension guidelines
Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.
Working with Markdown
You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:
For more information
Note: This project is to be a concrate application of my research studies. this is a reasearch project and is NOT to be used in production environments.