yash/refactor/natspec

[0xpanicError]

Note

Low Risk
Changes are mostly comments and reordering; the only behavioral footgun is WeETH’s renamed ZeroAddress error and constructor struct moves affecting new deployments and error decoders, not live upgrade logic.

Overview
This PR is a documentation and layout refactor across core staking contracts (EETH, WeETH, LiquidityPool), DepositAdapter, and Liquifier: it adds NatSpec (@notice / @param / @dev), groups code under section banners (constructor, mint/burn, pausing, getters, modifiers), and reorders some members for readability (e.g. permit and EIP-712 helpers in EETH, receive() placement in LiquidityPool).

Shared types move into interfaces: ConstructorAddresses and SourceOfFunds land on ILiquidityPool; Liquifier and new IDepositAdapter get their own ConstructorAddresses / SourceOfFunds, and DepositAdapter now implements IDepositAdapter with a single struct constructor instead of many address parameters.

Small non-doc deltas: WeETH renames AddressZero to ZeroAddress (same checks, different custom error); Liquifier replaces a local _min with Math.min. No intentional changes to mint/burn, rate limits, pause gates, or withdrawal guard logic are evident in the diff.

^{Reviewed by Cursor Bugbot for commit 189f19e. Bugbot is set up for automated code reviews on this repo. Configure here.}

[chatgpt-codex-connector]

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.