Skip to content

Commit

Permalink
Added some short instructions on using the 'construct' Doxygen comment.
Browse files Browse the repository at this point in the history
  • Loading branch information
james-strauss-uwa committed Mar 1, 2022
1 parent c706ebc commit 23b4d17
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/development/app_development/eagle_app_integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,19 @@ In order to support the direct usage of newly written application components in

#. The *category* param should be set to *DynlibApp* for C/C++ code, and *PythonApp* for Python code.

#. The *construct* param should be set to Scatter or Gather. Or omitted entirely for components that will not be embedded inside a construct.

The additional comments describe both the input/output ports for a component, and the parameters of a component. Shown below are example comments for C/C++ and Python applications.

Construct
"""""""""

If a component is intended to implement a scatter or gather construct, then the *construct* param should be added to the Doxygen markup. When a component is flagged with a construct param, the component will be added to the palette as usual, but the component will also be added to the palette a second time embedded within an appropriate construct. Here is an example usage:

.. code-block:: python
# @param construct Scatter
Parameters
""""""""""

Expand Down

0 comments on commit 23b4d17

Please sign in to comment.