From 23b4d175869b3bb2778f6322704f285fc4478f90 Mon Sep 17 00:00:00 2001 From: james-strauss-uwa Date: Tue, 1 Mar 2022 17:43:46 +0800 Subject: [PATCH] Added some short instructions on using the 'construct' Doxygen comment. --- .../app_development/eagle_app_integration.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/development/app_development/eagle_app_integration.rst b/docs/development/app_development/eagle_app_integration.rst index 336ebe98b..53dd4abae 100644 --- a/docs/development/app_development/eagle_app_integration.rst +++ b/docs/development/app_development/eagle_app_integration.rst @@ -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 """"""""""