feat: add ABAP Doc comments to all public methods and interfaces#45
Merged
Conversation
Fixes 18 abapdoc abaplint violations across 13 files: - auth: zasis_cx_no_auth constructor, zasis_if_auth_checker (4 methods) - bo: zasis_cl_interpreter constructor, zasis_cl_ruleset constructor, zasis_cl_ruleset_factory (3 methods), zasis_cx_ruleset_ui constructor, zasis_if_customlogic execute, zasis_if_customlogic_resolver resolve, zasis_if_ev_producer_resolver resolve, zasis_if_event_producer on_item_interpreted, zasis_if_interpreter execute - utils: zasis_cl_class_validator check_implements, zasis_cx_exc constructor
Replace minimal shortText-only comments with full ABAP Doc blocks following the official @parameter | desc and @Raising | desc syntax. All 13 affected files now document every parameter and exception.
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
1 participant
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.
Adds abapdoc (
"!) comments to all public methods and interface methods that triggered the newabapdocabaplint rule.