docs(contracts): add Rust doc comments to all public contract functions#3
Open
pauljacobb wants to merge 1 commit into
Open
docs(contracts): add Rust doc comments to all public contract functions#3pauljacobb wants to merge 1 commit into
pauljacobb wants to merge 1 commit into
Conversation
AnnabelJoe#319) - energy_token: enhanced balance() and total_supply() with examples - audit_registry: enhanced anchor(), verify(), api_signer(), admin() with full Arguments/Errors/Example sections - community_governance: enhanced set_quorum_bps, get_quorum_bps, set_threshold_bps, get_threshold_bps, pending_upgrade, get_execution_timelock, proposal_count with Panics/Arguments/Examples All public functions now have /// doc comments with Panics, Arguments, Authorization, and example invocations where applicable. Closes AnnabelJoe#319
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.
Summary
Ensures every public function across all three Soroban contracts has complete
///doc comments covering arguments, authorization, panics, errors, and example invocations.Changes
apps/contracts/energy_token/src/lib.rs— enhancedbalance(),total_supply()apps/contracts/audit_registry/src/lib.rs— enhancedanchor(),verify(),api_signer(),admin()apps/contracts/community_governance/src/lib.rs— enhancedset_quorum_bps(),get_quorum_bps(),set_threshold_bps(),get_threshold_bps(),pending_upgrade(),get_execution_timelock(),proposal_count()Acceptance criteria
///doc commentscargo docgenerates without warnings (no undocumented public items)Closes AnnabelJoe#319