escrow: 6 public functions have no rustdoc comment at all (get_admin, get_oracle, get_treasury, get_fee_bps, get_version, get_max_sponsors)

[abayomicornelius]

Overview

With #![warn(missing_docs)] not enabled anywhere in this workspace (tracked separately in the companion issue filed in this batch), nothing currently catches undocumented pub fns. A direct scan of contracts/escrow/src/lib.rs for pub fn declarations with no preceding /// doc comment finds six: get_admin (line 652), get_oracle (659), get_treasury (666), get_fee_bps (673), get_version (680), get_max_sponsors (684). Every other public function in this file (initialize, fund, contribute, release, refund, extend_deadline, keep_alive, pause, set_admin, set_fee_bps, etc.) has a substantial doc comment — these six view functions are the only ones with none at all, an inconsistency within the same file.

Requirements

Add a one-to-few-line /// doc comment to each of the six functions listed above, describing what it returns and, where relevant (e.g. get_version), any non-obvious default behavior.

Acceptance Criteria

• All six functions documented
• cargo doc --workspace --no-deps --document-private-items still passes

Additional Notes

Verified by scanning contracts/escrow/src/lib.rs for pub fn lines with no immediately-preceding /// line.

[rupesh-kumar-sah]

Hey team,

I would love to take this on. My planned approach:

• Implement escrow: 6 public functions have no rustdoc comment at all (get_admin, get_oracle, get_treasury, get_fee_bps, get_version, get_max_sponsors) with explicit require_auth checks, secure state storage, and gas optimization.
• Cover contract calls with hermetic unit tests verifying events and token balances.

I am ready to start immediately—please feel free to assign this to me!

[rushikeshgarad2024-dev]

Resolved in #393. Added rustdoc comments across all public getter and view functions in contracts/escrow/src/lib.rs.

Payout address (Stellar): GC5U46IS25KYFKNHDXEHR3KTQB3DVIBM4NW5BH4MVUE2G77STCJP4IHF