Skip to content

Commit

Permalink
Add doxygen for a generic data component, with a 'dataclass' parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
james-strauss-uwa committed Aug 24, 2022
1 parent 459e15d commit cf36b74
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion daliuge-engine/dlg/drop.py
Original file line number Diff line number Diff line change
Expand Up @@ -1176,7 +1176,18 @@ def get_dir(self, dirname):
def path(self) -> str:
return self._path


##
# @brief Data
# @details A generic Data drop, whose functionality can be provided by an arbitrary class, as specified in the 'dataclass' component parameter
# @par EAGLE_START
# @param category Data
# @param tag daliuge
# @param dataclass Data Class/my.awesome.data.Component/String/ComponentParameter/readonly//False/False/The python class that implements this data component
# @param data_volume Data volume/5/Float/ComponentParameter/readwrite//False/False/Estimated size of the data contained in this node
# @param group_end Group end/False/Boolean/ComponentParameter/readwrite//False/False/Is this node the end of a group?
# @param dummy dummy//Object/InputPort/readwrite//False/False/Dummy input port
# @param dummy dummy//Object/OutputPort/readwrite//False/False/Dummy output port
# @par EAGLE_END
class DataDROP(AbstractDROP):
"""
A DataDROP is a DROP that stores data for writing with
Expand Down

0 comments on commit cf36b74

Please sign in to comment.