|
FhSim
3.1.0
Marine systems simulation
|
| ID | 0077 |
| Class | DOCUMENTATION |
| Severity | 1 |
| Status | ready |
| Models | Trawl/Vessel, Trawl/TrawlDoorBase, Trawl/TrawlDoor |
| Found | 2026-09-26, OpenWiki pass |
| Decision needed |
grep -c "Description here" at HEAD: src/trawl/ToVessel.h 6, src/trawl/TrawlDoorBase.h 14, src/trawl/ToTrawlDoor.h 14.
ToVessel.h:46-49,58-59: WarpVel1...WarpVel<NumWarps>, Pos, Vel, Heading, ApSpeed, NumWarps. Also open @todos at ToVessel.h:12 ("Complete documentation, and
fix example file") and :33 ("Add config details"); the example excerpt at :25-31 has only LibName, SimObject and Name.TrawlDoorBase.h:76-89,99: Curvature, IsPort, AR, MaxLiftCoeff, DragCoeffAtMaxLift, WarpPos, LBPos, UBPos, COG, VisualizationScale, LengthScale, BreadthScale, CurvatureScale, Omega; @todos at :48 and :104.ToTrawlDoor.h:77-90,100: the same fourteen, copied; @todos at :16 and :46.Readers only: these models' documentation pages give no meaning, unit or frame for most of their parameters and ports.
Write each description from the code that reads it (ToVessel.cpp/TrawlVessel.cpp, TrawlDoorBase.cpp): unit, frame, default and what it drives. TrawlDoorBase.h and ToTrawlDoor.h can share the text. Where the code does not settle a meaning, leave the entry for the owner rather than guess.
grep -c "Description here" is 0 in the three headers.
None; comments only, provided the descriptions are taken from the code.