Harden Spoon Javadoc parsing and provenance#12
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR hardens CoCoMUT's Javadoc parsing path around the official Spoon Javadoc parser and makes the output contract explicit for downstream evaluation.
Major changes:
fr.inria.gforge.spoon:spoon-javadocMaven artifact rather than relying on local Spoon checkout code.JavadocParser.forElement(...)and resolve typed Spoon references first for@see,{@link ...}, and{@linkplain ...}.CtExecutableReference,CtFieldReference,CtTypeReference, andCtPackageReference, while keeping raw target text as provenance.@see #sameNameremain ambiguous when multiple overloads exist.seeandinline_linksarrays derive from the final mergedjavadoc_referenceslist, preferring Spoon-backed entries and keeping fallback-only values only when needed.parse_confidence,spoon_reference,canonical_target,raw_pairing_confidence, andfallback_reason.doc-files,{@docRoot},@filename, and{@snippet file=...}with project-root containment checks.{@inheritDoc}is currently candidate-only: inherited Javadocs are exposed as candidates and not silently expanded into childstructured_tags.Tests
./mvnw -q -pl analyzer-tests -am -Dtest=SourceModelEdgeCaseTest -Dsurefire.failIfNoSpecifiedTests=false test./mvnw -q testgit diff --checkNote: local commit hooks still fail on missing Maven
formatterplugin prefix resolution. The commits were created with--no-verifyonly after the focused and full Maven suites passed.