Skip to content

Address Feature Request Issue 114: Update APIs to match codeanalyzer 2.3.0 #115

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

Conversation

rahlk
Copy link
Collaborator

@rahlk rahlk commented Feb 21, 2025

Motivation and Context

With this PR, CLDK now introduces Comment Parsing APIs in CLDK, allowing structured extraction of comments at various levels:

  • File, class, method, and doc-string levels.
  • Report declarations are now captured.
  • Callable parameter parsing allows identification of methods with non-zero parameters.
  • Column and line locations of these methods are now available.

How Has This Been Tested?

The following new tests were added:

  • test_get_all_comments and test_get_all_docstrings for now to exercise new API methods.

Breaking Changes

No breaking changes. But there are new APIs that extend existing functionality without modifying the core behavior.

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

  • Improved internal API documentation to reflect these changes.
  • Updated test suite to ensure correctness.
  • Future extensions could include support for inline comments and semantic analysis of documentation comments.

…APIs at file, class, method, and docstring level. We can capture report declarations, and we can parse callable parameters, get a list of methods with non-zero parameters and get their column and line locations

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
…APIs at file, class, method, and docstring level. We can capture report declarations, and we can parse callable parameters, get a list of methods with non-zero parameters and get their column and line locations

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
…APIs at file, class, method, and docstring level. We can capture report declarations, and we can parse callable parameters, get a list of methods with non-zero parameters and get their column and line locations

Signed-off-by: Rahul Krishna <i.m.ralk@gmail.com>
@rahlk rahlk self-assigned this Feb 21, 2025
@rahlk rahlk added enhancement New feature or request kind/feature New feature(s) refactoring Refactoring labels Feb 21, 2025
@rahlk rahlk merged commit 36daf8d into main Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request kind/feature New feature(s) refactoring Refactoring
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support Better Java Comment Parsers, Report Declarations, and Parameter Location Parsing
1 participant