Start of updated documentation

docs/development/app_development/eagle_app_integration.rst

@@ -26,20 +26,14 @@ The xml2palette.py script can be run using this command line:
 
 .. code-block:: none
 
-  python3 xml2palette.py -i <path_to_input_directory> -o <path_output_file>
+  python3 xml2palette.py -i <path_to_input_directory> -t <tag> -o <path_output_file>
 
 
-The xml2palette.py script expects several enviroment variables to be present:
+If no tag is specified, all components found in the input directory will part of the output file. If, however, a tag is specified, then only those components with a matching tag will be part of the output. Tags can be added to the Doxygen comments for a component using:
 
-#. PROJECT_NAME (e.g. "leap")
-#. PROJECT_VERSION (e.g. "abcd1234")
-#. GIT_REPO (e.g. "https://gitlab.com/ska-telescope/icrar-leap-accelerate.git")
-
-These requirements can all be combined together on a single command line:
-
-.. code-block:: none
+.. code-block:: python
 
-  PROJECT_NAME=<project_name> PROJECT_VERSION=$(git rev-parse --short HEAD) GIT_REPO=$(git config --get remote.origin.url) python3 xml2palette.py -i <path_to_input_directory> -o <path_output_file>
+  # @param tag <tag_name>
 
 Component Doxygen Markup Guide
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -58,16 +52,32 @@ Component Parameters are specified using the "param" command from doxygen. The c
 
 .. code-block:: python
 
-  # @param param/<internal_name> <user-facing name>/<default_value>/<type>/<access_descriptor>/<precious>/<description>
+  # @param param/<internal_name> <user-facing name>/<default_value>/<type>/<access_descriptor>/<precious>/<options>/<positional>/<description>
   #
   # e.g.
   #
-  # @param param/start_frequency Start Frequency/500/Integer/readwrite/False/
+  # @param param/start_frequency Start Frequency/500/Integer/readwrite/False//False/
   #     \~English the start frequency to read from
   #     \~Chinese 要读取的起始频率
 
 The **precious** flag indicates that the value of the parameter should always be shown to the user, even when the parameter contains its default value. The flag also enforces that the parameter will always end-up on the command line, regardless of whether it contains the default value.
 
+The **positional** flag indicates that this parameter is a positional argument on a command line, and will be added to the command line without a prefix.
+
+Parameter Types
+"""""""""""""""
+
+Available types are:
+
+#. String
+#. Integer
+#. Float
+#. Complex
+#. Boolean
+#. Select
+#. Password
+#. Json
+
 Ports
 """""
 
@@ -94,13 +104,13 @@ Complete example for C/C++
   * of the parset to load a measurement set.
   * \par EAGLE_START
   * \param category DynlibApp
-  * \param[in] param/start_frequency Start Frequency/500/Integer/readwrite/False/
+  * \param[in] param/start_frequency Start Frequency/500/Integer/readwrite/False//False/
   *     \~English the start frequency to read from
   *     \~Chinese 要读取的起始频率
-  * \param[in] param/end_frequency End Frequency/500/Integer/readwrite/False/
+  * \param[in] param/end_frequency End Frequency/500/Integer/readwrite/False//False/
   *     \~English the end frequency to read from
   *     \~Chinese 要读取的结束频率
-  * \param[in] param/channels Channels/64/Integer/readonly/False/
+  * \param[in] param/channels Channels/64/Integer/readonly/False//False/
   *     \~English how many channels to load
   *     \~Chinese 需要加载的通道数量
   * \param[in] port/config Config/String/
@@ -126,13 +136,13 @@ Complete example for Python
   # of the parset to load a measurement set.
   # @par EAGLE_START
   # @param category PythonApp
-  # @param[in] param/start_frequency Start Frequency/500/Integer/readwrite/False/
+  # @param[in] param/start_frequency Start Frequency/500/Integer/readwrite/False//False/
   #     \~English the start frequency to read from
   #     \~Chinese 要读取的起始频率
-  # @param[in] param/end_frequency End Frequency/500/Integer/readwrite/False/
+  # @param[in] param/end_frequency End Frequency/500/Integer/readwrite/False//False/
   #     \~English the end frequency to read from
   #     \~Chinese 要读取的结束频率
-  # @param[in] param/channels Channels/64/Integer/readonly/False/
+  # @param[in] param/channels Channels/64/Integer/readonly/False//False/
   #     \~English how many channels to load
   #     \~Chinese 需要加载的通道数量
   # @param[in] port/config Config/String/