Feature/hld iofields
1 unresolved thread
1 unresolved thread
Compare changes
@@ -7,7 +7,8 @@ This class can used to add model specific output data to a custom @ref vtkoutput
- returns the human readable name for the primary variable with index `pvIdx`. Models that do not use primary variable switching, will have always `state = 0`. In case of a primary variable switch (PVS) model, `state` has to be explicitly given when calling. Note that the state has to be known to correctly interpret the primary variables in case of a PVS model.
I'm taking this as an example sorry. I think descriptions like these will lead to a lot of duplicate documentation or a fragmented documentation. The respective function also has function documentation in the code. If the description here is better it should really be there.
But if you think mentioning these interfaces in the HLD is a huge benefit I would propose the following:
If a base/interface/default implementation class doesn't exist, create an archetype (https://en.cppreference.com/w/cpp/language/archetype) and document the interfaces and link to that.
An alternative could be to link to all implementations by linking to a doxygen group and document that group and ingroup all implementations and combine this with
@copybrief