docProcessorGradlePlugin
docProcessorGradlePlugin copied to clipboard
Here's the revised commit message:
Fix: Improve KDoc parameter rendering in IntelliJ plugin
This commit addresses issue #85 by enhancing how KDoc parameters are rendered in the KoDEx IntelliJ plugin. The rendering now takes into account the results of KDoc processing by KoDEx.
Key changes include:
-
Structured KDoc Tags:
DocContentinkodex-commonhas been refactored to parse and store KDoc tags (like@param,@return) in a structured list (structuredTags) ofKDocTagobjects. EachKDocTagholds the tag name, its subject (e.g., parameter name), and its description.DocumentableWrappernow uses this list ofKDocTags, replacing the previousSet<String>of tag names.
-
Service Layer Update:
DocProcessorServiceinkodex-intellij-pluginwas updated to be compatible with the changes inDocumentableWrapper(specifically howcopy()is called).
-
Enhanced Documentation Provider:
DocProcessorInlineDocumentationProvidernow utilizes thestructuredTagsfrom the processedDocContent.- It includes new logic (
buildDocumentationHtml) to generate HTML for display in IntelliJ, with specific formatting for@paramtags to correctly show their names and processed descriptions. - Fallback to default rendering is maintained if processed content isn't available.
-
Unit Tests:
- Added unit tests for
DocContentinkodex-commonto verify the correctness of the KDoc parsing intostructuredTags.
- Added unit tests for
These changes ensure that modifications made by KoDEx processors to KDoc tags (particularly @param descriptions) are accurately reflected in the documentation displayed within the IntelliJ IDEA, such as in quick doc popups and inline documentation.