Document mnDiagram distance and number formatting helpers - #3445
itsgrimetime merged 4 commits into
Conversation
ribbanya
left a comment
There was a problem hiding this comment.
I'm not sure this is something we want to do, see #2938. We might be forced to place documentation at the definition. I'm not really sure what the best layout is but it's not great to churn one way and then the other. We need to look more at how large/stable codebases are handling this problem.
|
The main reason for using .dox files was to document struct fields separate from the definition, mostly because HAL likes to declare 2000-line structs that are annoying to wade through if each field also has multi-line documentation. I really don't know what the best solution is. |
|
makes sense. i'll play around with some stuff and do some thinking as well and see if I can't come up with some ideas |
9bd82e4 to
2d16c14
Compare
Document the diagram distance and formatting helpers above their prototypes in mndiagram.h and remove inaccurate inline claims about display units, caps, and time formatting from mndiagram.c. Align the mnDiagram_FormatDecimalNumber prototype's parameter name with its definition (decimal_places). Validated the documented boundary and formatting contracts with 73 controlled Dolphin 2509 / GALE01 v1.02 cases, including both saved-language branches. main.dol OK; mndiagram, mndiagram2, and mndiagram3 remain 100% matched. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
2d16c14 to
0e2988d
Compare
|
Updated this onto current master. The helper documentation now lives on the real declarations in |
Summary
mnDiagramdistance and number-formatting helpers at their declarations inmndiagram.hmnDiagram_FormatDecimalNumberprototype parameter name with its definition.doxredeclarationsRuntime validation
The documented boundary and formatting contracts were checked with 73 controlled Dolphin 2509 / GALE01 v1.02 cases, including both saved-language branches.
Build verification
upstream/masterninjapython configure.py progress08e0bf20134dfcb260699671004527b2d6bb1a45git diff --check