Add rustdoc comments to src/contracts/logic.rs and proxy_entry.rs

[EmmanuelAdah]

Closes #246

📝 Summary

This PR improves the developer experience and crate documentation by adding detailed, structured rustdoc comments to all public-facing and crate-internal functions within the core contract modules (logic.rs and proxy_entry.rs).

🛠 What was done

Added /// doc comments to all pub and pub(crate) functions in:

src/contracts/logic.rs
src/contracts/proxy_entry.rs

Standardized the documentation format for each function to explicitly include:

Parameters: Descriptions of all input arguments.
Returns: Expected successful return types/values.
Errors: Specific conditions that will trigger a ContractError or panic.
Side Effects: Explicit mentions of storage reads/writes, emitted events, required authorizations, and external cross-contract calls.

⚠️ Impact & Functional Changes

Zero functional changes. This PR is strictly limited to documentation.

cargo doc will now generate clean, warning-free, and highly readable HTML documentation for the contract's API and internal logic.

Note: The #![allow(missing_docs)] attribute in proxy_entry.rs can now be safely removed in a future strict-linting pass if desired, as all functions are fully documented.

✅ Checklist

• Code compiles cleanly (cargo build)
• Documentation builds perfectly (cargo doc --no-deps --document-private-items)
• No functional logic was altered

[N-thnI]

Please resolve conflicts

[N-thnI]

please ensure all checks pass

[N-thnI]

This has gone into conflict with main — could you rebase onto main and resolve?