Skip to content

Feature Request Issue 102: Enrich comment analysis capabilities #124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Feb 19, 2025

Conversation

rahlk
Copy link
Collaborator

@rahlk rahlk commented Feb 19, 2025

Summary

This PR introduces rich comment analysis features, enhancing the ability to extract and associate comments with AST nodes, including File, Javadoc, block, and inline comments.

Motivation and Context

This update improves comment extraction expressivity.
Developers/tools integrating with this comment parsing logic will need to adapt to the new extraction behavior.

How Has This Been Tested?

  • Unit tests: All existing test cases pass.
  • New test case added: mustBeAbleToExtractCommentBlocks ensures correct block comment extraction.

Breaking Changes

⚠️ Caveat Emptor! This is a breaking change that affects how the analysis.json looks comments are extracted and structured and new fields are added.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the Codellm-Devkit Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Additional context

This update enhances how JavaParser processes comments at different AST levels, ensuring structured extraction of Javadoc, block, and inline comments.

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
…llable.

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
…llable.

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
…nUnit to capture package information.

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
…nUnit to capture package information.

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
…nUnit to capture package information.

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
@rahlk rahlk added documentation Improvements or additions to documentation enhancement New feature or request kind/feature Feature breaking Breaking Change labels Feb 19, 2025
@rahlk rahlk requested a review from sinha108 February 19, 2025 17:35
@rahlk rahlk self-assigned this Feb 19, 2025
@rahlk rahlk linked an issue Feb 19, 2025 that may be closed by this pull request
@rangeetpan rangeetpan self-requested a review February 19, 2025 21:36
@rahlk rahlk merged commit 5d6be16 into main Feb 19, 2025
@rahlk rahlk deleted the 102-create-comprehensive-comment-analysis-capabilities branch February 19, 2025 21:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking Breaking Change documentation Improvements or additions to documentation enhancement New feature or request kind/feature Feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create comprehensive comment analysis capabilities
2 participants