Documented API table for `CampaignContract::*` should replace per-method drifting comments

[P3az3]

Problem Statement The contract has the following public methods, but their documented behavior is scattered across many inline doc-comments:

• initialize, donate, get_total_raised, get_donation_count, get_donor_count, get_release_count, get_total_tx_count, get_campaign_report, get_platform_summary, get_dashboard_metrics, get_donor_record, hello, version, is_refund_eligible, claim_refund, end_campaign, cancel_campaign, extend_deadline, get_campaign_status, release_milestone, release_milestone_multi_asset, get_milestone_view, get_all_milestones, upgrade, freeze, unfreeze.

There is no central table. Drift between docs and code is hard to detect.

Expected Outcome A new docs/api.md with a comprehensive table:

Method	Auth	Mutates	Events Emitted	Idempotent	Errors
initialize	creator	yes	campaign_initialized	no (once-only)	...
...

Updated as each method changes.

Acceptance Criteria

• docs/api.md exists.
• Cross-references from each method's /// doc comment.
• CI step fails if docs/api.md is inconsistent with the actual contract (likely a manual review gate).

Implementation Notes

• Generate this table from clap or specta if appropriate.

Affected Files / Modules

• New: docs/api.md
• campaign/src/lib.rs
• README.md (link)

Dependencies — None.

[Sammygee12]

Hello Maintainer, I'd like to work on this issue. I have experience with backend development and state management, and I can implement this. Please consider assigning it to me.

[divinemike019]

Hi, I'd like to work on this issue. Since the per-method doc comments on CampaignContract:* currently drift out of sync with the actual implementation over time, my plan is to replace them with a single, well-structured documented API table that serves as the authoritative reference — covering each method's signature, parameters, return type, and behavior in one place that's easier to keep accurate than scattered inline comments.

I'll go through every method on CampaignContract to make sure the table is complete and correct against the current implementation (not just copying over any existing drifted comments), and remove or trim the redundant per-method comments once they're properly captured in the table, so there's a single source of truth going forward.

I have experience with technical documentation for smart contracts, and I'm happy to share a draft early for feedback before submitting the final PR.

[grantfox-oss]

🦊 GrantFox — @Sammygee12 has been assigned to this issue as part of the Official Campaign | FWC26 campaign!

Next steps:

1. Open a Pull Request referencing this issue (e.g., Closes #42)
2. Your PR will be reviewed by the MillestoneX maintainers

Good luck! Track your progress on GrantFox.