idea plugin support #998

shalousun · 2024-12-16T11:57:00Z

shalousun
Dec 16, 2024
Maintainer

IDEA Plugin for API Documentation Generation:
- The IntelliJ IDEA plugin allows users to easily generate API documentation directly within the IDE. This streamlines the documentation process and integrates it seamlessly into the development workflow.
YAML Configuration Support for smart-doc-maven-plugin and smart-doc-gradle-plugin:
- Both the Maven and Gradle plugins for smart-doc now support YAML configuration files. This provides a more readable and maintainable way to define the settings that were previously stored in smart-doc.json. YAML's hierarchical structure and human-readable syntax make it an excellent choice for complex configurations.
Configuration Assistance in IDEA Plugin:
- The IDEA plugin includes intelligent code completion, validation, and documentation for smart-doc configurations. This helps developers write correct and efficient configurations with minimal effort. The design of this feature is inspired by the Spring Assistant plugin, which offers similar assistance for Spring Boot applications.

First, Implement Automatic Suggestions and Hints for YAML Configuration:
- We will prioritize the implementation of intelligent code completion, validation, and documentation support for YAML configurations in the IDEA plugin. This will help developers write correct and efficient configurations with minimal effort. The design of this feature will be inspired by tools like the Spring Assistant plugin, which offers similar assistance for Spring Boot applications.
Defer API Documentation Generation:
- The functionality to generate API documentation using the IDEA plugin can be developed in a subsequent phase. This allows us to focus on enhancing the developer experience with robust configuration support before moving on to the documentation generation features.

We welcome everyone to actively participate in discussions and contribute to the development of these features.