Docs core dispatcher v2Docs: Add technical YARD documentation for Core command dispatcher#21283
Closed
Ganesh-abc wants to merge 2 commits intorapid7:masterfrom
Closed
Docs core dispatcher v2Docs: Add technical YARD documentation for Core command dispatcher#21283Ganesh-abc wants to merge 2 commits intorapid7:masterfrom
Ganesh-abc wants to merge 2 commits intorapid7:masterfrom
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
3 participants
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 follows the documentation improvements introduced in #21279 and originally discussed in #21225.
While #21279 focuses on the Modules command dispatcher, this PR applies similar technical YARD documentation improvements to the Core command dispatcher to maintain consistency across dispatcher components.
These changes remain documentation-only and do not modify runtime behavior.
Changes
Added YARD documentation for:
Added @param tags for method arguments
Added @return tags for return values
Documentation-only changes (no logic modifications)
Purpose
These updates improve developer clarity and assist in generating accurate framework documentation while maintaining existing functionality.
Verification
ruby -c lib/msf/ui/console/command_dispatcher/core.rb→ Syntax OKcdcommand works inmsfconsolecolorcommand works inmsfconsolePlease let me know if any additional verification steps would be helpful.