GunnsDraw Documentation Shapes Library - nasa/gunns GitHub Wiki

These are help pages for the shapes found in the gunns/draw/libraries/GUNNS_Doxygen.xml shape library. These are meant to contain documentation and notices that are included in the exported network code as Doxygen styled comments. These are listed by the order they appear in the shape library in Draw.io:

Copyright: the text in this box is exported to the network’s .hh and .cpp files as a @copyright doxygen comment, towards the top of each file. Modify the text in this box to your liking.
License: same as the Copyright above, but this is to hold software license notifications and goes into the exported code as a @license doxygen comment
Document Data: this holds doxygen group information, and you can add more doxygen fields. Modify the defgroup and ingroup shape data fields as desired. These are exported to the network header file as @defgroup and @ingroup statements, respectively. You can also add more fields by adding properties in the Draw.io Edit Data window. Each property/value pair gets exported to the network header file as a @property value doxygen comment along with the @defgroup and @ingroup lines. However note this has a limitation that you can only have one property of a given name, so you couldn’t have multiple @author lines, etc.
General Notice: this holds general notices that are meant to be prominently displayed in the drawing and exported code. This would be useful for things like company sensitive or export control restrictions. You should put this in a ‘Notices’ layer at the bottom of the layers list in the drawing: this puts it towards the top of the saved drawing file. See the gunns/draw/drawings/EmptyNetwork.xml drawing as an example. The text in this box will be included as a doxygen @attention comment at the top of the exported network code.
References: this is a list of bibliography references for your drawing, that is exported to the network code .hh file in the REFERENCES section of the @details doxygen paragraph.
Assumptions and Limitations: this is a list of assumptions and limitations for your model. Like the References above, these are exported to the network code .hh file in the @details doxygen paragraph.