docs: api_reference.md missing class documentation for CornerSweepResult, DCIncResult, DCXFResult, and ACXFResult #75
Description
Problem
api_reference.md documents the following methods and their return types, but does not include class documentation for the returned types:
| Method | Return Type | Documented? |
|---|---|---|
run_corners() |
CornerSweepResult |
❌ Missing |
run_dcinc() |
DCIncResult |
❌ Missing |
run_dcxf() |
DCXFResult |
❌ Missing |
run_acxf() |
ACXFResult |
❌ Missing |
Compare with TransientResult, ACResult, NoiseResult, and CornerResult which have full class documentation.
Impact
Without knowing the fields and methods of these return types, users cannot productively use the results:
CornerSweepResult (corners.py): has .results, .num_corners, .num_converged, .all_converged, .get_result(name), .converged_results() — user has no way to know how to iterate results.
DCIncResult (xfer.py): has incremental_voltages: Dict[str, float] and dc_voltages: Optional[Array].
DCXFResult (xfer.py): has tf, zin, yin (transfer function, input impedance, input admittance), out_node, dc_voltages. The run_dcxf() description says only "transfer function magnitude and phase" which misses the impedance data.
ACXFResult (xfer.py): same fields as DCXFResult but complex-valued over frequency.
Fix
Add @dataclass class doc blocks in api_reference.md for each of these 4 types, similar to how TransientResult is documented.