Updates to doxygen to use 'aparam/cparam' and to add missing 'preciou…

…s' attributes.

daliuge-engine/dlg/apps/archiving.py

@@ -82,17 +82,17 @@ def store(self, inputDrop):
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] cparam/appclass Application class/dlg.apps.archiving.NgasArchivingApp/String/readonly/
+# @param[in] cparam/appclass Application class/dlg.apps.archiving.NgasArchivingApp/String/readonly/False/
 #     \~English Application class
-# @param[in] param/ngasSrv NGAS Server URL/localhost/String/readwrite/
+# @param[in] aparam/ngasSrv NGAS Server URL/localhost/String/readwrite/False/
 #     \~English URL of the NGAS Server
-# @param[in] param/ngasPort NGAS Server Port/7777/Integer/readwrite/
+# @param[in] aparam/ngasPort NGAS Server Port/7777/Integer/readwrite/False/
 #     \~English TCP/IP Port on the NGAS Server
-# @param[in] param/ngasMime NGAS Mime Type/"application/octet-stream"/String/readwrite/
+# @param[in] aparam/ngasMime NGAS Mime Type/"application/octet-stream"/String/readwrite/False/
 #     \~English Mime-type of the NGAS payload
-# @param[in] param/ngasTimeout NGAS Server Timeout/2/Integer/readonly/
+# @param[in] aparam/ngasTimeout NGAS Server Timeout/2/Integer/readonly/False/
 #     \~English Archiving request timeout
-# @param[in] param/ngasConnectTimeout NGAS Server Connect Timeout/2/Integer/readonly/
+# @param[in] aparam/ngasConnectTimeout NGAS Server Connect Timeout/2/Integer/readonly/False/
 #     \~English NGAS Server connection timeout
 # @param[in] port/fileObject File Object/File/
 #     \~English Input File Object

daliuge-engine/dlg/apps/bash_shell_app.py

@@ -331,13 +331,13 @@ def execute(self, data):
 # @par EAGLE_START
 # @param category BashShellApp
 # @param tag template
-# @param[in] param/command Command//String/readwrite/False/
+# @param[in] aparam/command Command//String/readwrite/False/
 #     \~English The command to be executed
-# @param[in] param/input_redirection Input Redirection//String/readwrite/False/
+# @param[in] aparam/input_redirection Input Redirection//String/readwrite/False/
 #     \~English The command line argument that specifies the input into this application
-# @param[in] param/output_redirection Output Redirection//String/readwrite/False/
+# @param[in] aparam/output_redirection Output Redirection//String/readwrite/False/
 #     \~English The command line argument that specifies the output from this application
-# @param[in] param/command_line_arguments Command Line Arguments//String/readwrite/False/
+# @param[in] aparam/command_line_arguments Command Line Arguments//String/readwrite/False/
 #     \~English Additional command line arguments to be added to the command line to be executed
 # @par EAGLE_END
 class BashShellApp(BashShellBase, BarrierAppDROP):

daliuge-engine/dlg/apps/dynlib.py

@@ -354,7 +354,7 @@ def addStreamingInput(self, streamingInputDrop, back=True):
 # @par EAGLE_START
 # @param category DynlibApp
 # @param tag template
-# @param[in] param/libpath Library Path//String/readwrite/
+# @param[in] cparam/libpath Library Path//String/readwrite/False/
 #     \~English The location of the shared object/DLL that implements this application
 # @par EAGLE_END
 class DynlibApp(DynlibAppBase, BarrierAppDROP):

daliuge-engine/dlg/apps/plasma.py

@@ -49,9 +49,9 @@
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/plasma_path Plasma Path//String/readwrite/
+# @param[in] aparam/plasma_path Plasma Path//String/readwrite/False/
 #     \~English Path to plasma store.
-# @param[in] param/appclass Application class/dlg.apps.plasma.MSStreamingPlasmaConsumer/String/readonly/
+# @param[in] cparam/appclass Application class/dlg.apps.plasma.MSStreamingPlasmaConsumer/String/readonly/False/
 #     \~English Application class
 # @param[in] port/plasma_ms_input Plasma MS Input/Measurement Set/
 #     \~English Plasma MS input
@@ -137,9 +137,9 @@ def dropCompleted(self, uid, drop_state):
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/plasma_path Plasma Path//String/readwrite/
+# @param[in] aparam/plasma_path Plasma Path//String/readwrite/False/
 #     \~English Path to plasma store
-# @param[in] param/appclass Application class/dlg.apps.plasma.MSStreamingPlasmaProducer/String/readonly/
+# @param[in] cparam/appclass Application class/dlg.apps.plasma.MSStreamingPlasmaProducer/String/readonly/False/
 #     \~English Application class
 # @param[in] port/input_file Input File/File/
 #     \~English MS input file
@@ -206,7 +206,7 @@ def run(self):
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/appclass Application class/dlg.apps.plasma.MSPlasmaReader/String/readonly/
+# @param[in] cparam/appclass Application class/dlg.apps.plasma.MSPlasmaReader/String/readonly/False/
 #     \~English Application class
 # @param[in] port/plasma_ms_input Plasma MS Input/Measurement Set/
 #     \~English Plasma MS store input
@@ -269,7 +269,7 @@ def run(self, **kwargs):
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/appclass Application class/dlg.apps.plasma.MSPlasmaWriter/String/readonly/
+# @param[in] cparam/appclass Application class/dlg.apps.plasma.MSPlasmaWriter/String/readonly/False/
 #     \~English Application class
 # @param[in] port/input_ms Input MS/Measurement Set/
 #     \~English Input MS file

daliuge-engine/dlg/apps/pyfunc.py

@@ -108,18 +108,18 @@ def import_using_code(code):
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/appclass Application Class/dlg.apps.pyfunc.PyFuncApp/String/readonly/
+# @param[in] cparam/appclass Application Class/dlg.apps.pyfunc.PyFuncApp/String/readonly/False/
 #     \~English Application class
-# @param[in] param/func_name Function Name//String/readwrite/
+# @param[in] aparam/func_name Function Name//String/readwrite/False/
 #     \~English Python fuction name
-# @param[in] param/func_code Function Code//String/readwrite/
+# @param[in] aparam/func_code Function Code//String/readwrite/False/
 #     \~English Python fuction code, e.g. 'def fuction_name(args): return args'
-# @param[in] param/pickle Pickle//bool/readwrite/
+# @param[in] aparam/pickle Pickle//bool/readwrite/False/
 #     \~English Whether the python arguments are pickled.
-# @param[in] param/func_defaults Function Defaults//String/readwrite/
+# @param[in] aparam/func_defaults Function Defaults//String/readwrite/False/
 #     \~English Mapping from argname to default value. Should match only the last part
 #               of the argnames list
-# @param[in] param/func_arg_mapping Function Arguments Mapping//String/readwrite/
+# @param[in] aparam/func_arg_mapping Function Arguments Mapping//String/readwrite/False/
 #     \~English Mapping between argument name and input drop uids
 # @par EAGLE_END
 class PyFuncApp(BarrierAppDROP):

daliuge-engine/dlg/apps/scp.py

@@ -46,13 +46,13 @@
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/appclass Application Class/dlg.apps.scp.ScpApp/String/readonly/
+# @param[in] cparam/appclass Application Class/dlg.apps.scp.ScpApp/String/readonly/False/
 #     \~English Application class
-# @param[in] param/remoteUser Remote User//String/readwrite/
+# @param[in] aparam/remoteUser Remote User//String/readwrite/False/
 #     \~English Remote user address
-# @param[in] param/pkeyPath Private Key Path//String/readwrite/
+# @param[in] aparam/pkeyPath Private Key Path//String/readwrite/False/
 #     \~English Private key path
-# @param[in] param/timeout Timeout//Float/readwrite/
+# @param[in] aparam/timeout Timeout//Float/readwrite/False/
 #     \~English Connection timeout in seconds
 # @param[in] port/file File/PathBasedDrop/
 #     \~English Input file path

daliuge-engine/dlg/apps/simple.py

@@ -69,9 +69,9 @@ def run(self):
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/sleepTime Sleep Time/5/Integer/readwrite/
+# @param[in] aparam/sleepTime Sleep Time/5/Integer/readwrite/False/
 #     \~English The number of seconds to sleep
-# @param[in] param/appclass Application Class/dlg.apps.simple.SleepApp/String/readonly/
+# @param[in] cparam/appclass Application Class/dlg.apps.simple.SleepApp/String/readonly/False/
 #     \~English Application class
 # @par EAGLE_END
 class SleepApp(BarrierAppDROP):
@@ -103,7 +103,7 @@ def run(self):
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/appclass Application Class/dlg.apps.simple.CopyApp/String/readonly/False/
+# @param[in] cparam/appclass Application Class/dlg.apps.simple.CopyApp/String/readonly/False/
 #     \~English Application class
 # @par EAGLE_END
 class CopyApp(BarrierAppDROP):
@@ -137,6 +137,16 @@ def copyRecursive(self, inputDrop):
                 droputils.copyDropContents(inputDrop, outputDrop)
 
 
+##
+# @brief SleepAndCopyApp
+# @par EAGLE_START
+# @param category PythonApp
+# @param tag daliuge
+# @param[in] aparam/sleepTime Sleep Time/5/Integer/readwrite/False/
+#     \~English The number of seconds to sleep
+# @param[in] cparam/appclass Application Class/dlg.apps.simple.SleepAndCopyApp/String/readonly/False/
+#     \~English Application class
+# @par EAGLE_END
 class SleepAndCopyApp(SleepApp, CopyApp):
     """A combination of the SleepApp and the CopyApp. It sleeps, then copies"""
 
@@ -154,15 +164,15 @@ def run(self):
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/size Size/100/Integer/readwrite/
+# @param[in] aparam/size Size/100/Integer/readwrite/False/
 #     \~English The size of the array
-# @param[in] param/integer Integer/True/Boolean/readwrite/
+# @param[in] aparam/integer Integer/True/Boolean/readwrite/False/
 #     \~English Generate integer array?
-# @param[in] param/low Low/0/float/readwrite/
+# @param[in] aparam/low Low/0/float/readwrite/False/
 #     \~English Low value of range in array [inclusive]
-# @param[in] param/high High/1/float/readwrite/
+# @param[in] aparam/high High/1/float/readwrite/False/
 #     \~English High value of range of array [exclusive]
-# @param[in] param/appclass Application class/dlg.apps.simple.RandomArrayApp/String/readonly/
+# @param[in] cparam/appclass Application class/dlg.apps.simple.RandomArrayApp/String/readonly/False/
 #     \~English Application class
 # @param[out] port/array Array/Array/
 #     \~English Port carrying the averaged array
@@ -410,9 +420,9 @@ def combine_inputs(self):
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/greet Greet/World/String/readwrite/
+# @param[in] aparam/greet Greet/World/String/readwrite/
 #     \~English What appears after 'Hello '
-# @param[in] param/appclass Application Class/dlg.apps.simple.HelloWorldApp/String/readonly/
+# @param[in] cparam/appclass Application Class/dlg.apps.simple.HelloWorldApp/String/readonly/
 #     \~English Application class
 # @param[out] port/hello Hello/String/
 #     \~English The port carrying the message produced by the app.
@@ -463,9 +473,9 @@ def run(self):
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/url URL/"https://eagle.icrar.org"/String/readwrite/
+# @param[in] aparam/url URL/"https://eagle.icrar.org"/String/readwrite/False/
 #     \~English The URL to retrieve
-# @param[in] param/appclass Application Class/dlg.apps.simple.UrlRetrieveApp/String/readonly/
+# @param[in] cparam/appclass Application Class/dlg.apps.simple.UrlRetrieveApp/String/readonly/False/
 #     \~English Application class
 # @param[out] port/content Content/String/
 #     \~English The port carrying the content read from the URL.

daliuge-engine/dlg/apps/socket_listener.py

@@ -57,15 +57,15 @@
 # @par EAGLE_START
 # @param category PythonApp
 # @param tag daliuge
-# @param[in] param/appclass Application Class/dlg.apps.socket_listener.SocketListener/String/readonly/
+# @param[in] cparam/appclass Application Class/dlg.apps.socket_listener.SocketListener/String/readonly/False/
 #     \~English Application class
-# @param[in] param/host Host/127.0.0.1/String/readwrite/
+# @param[in] aparam/host Host/127.0.0.1/String/readwrite/False/
 #     \~English Host address
-# @param[in] param/port Port/1111/Integer/readwrite/
+# @param[in] aparam/port Port/1111/Integer/readwrite/False/
 #     \~English Host port
-# @param[in] param/bufsize Buffer Size/4096/String/readwrite/
+# @param[in] aparam/bufsize Buffer Size/4096/String/readwrite/False/
 #     \~English Receive buffer size
-# @param[in] param/reuseAddr Reuse Address/False/Boolean/readwrite/
+# @param[in] aparam/reuseAddr Reuse Address/False/Boolean/readwrite/False/
 #     \~English
 # @param[out] port/data Data/String/
 # @par EAGLE_END

daliuge-engine/dlg/drop.py

@@ -1696,21 +1696,21 @@ def dataURL(self):
 # @par EAGLE_START
 # @param category NGAS
 # @param tag template
-# @param[in] param/data_volume Data volume/5/Float/readwrite/
+# @param[in] cparam/data_volume Data volume/5/Float/readwrite/False/
 #     \~English Estimated size of the data contained in this node
-# @param[in] param/group_end Group end/False/Boolean/readwrite/
+# @param[in] cparam/group_end Group end/False/Boolean/readwrite/False/
 #     \~English Is this node the end of a group?
-# @param[in] param/ngsSrv NGAS Server/localhost/String/readwrite/
+# @param[in] aparam/ngsSrv NGAS Server/localhost/String/readwrite/False/
 #     \~English The URL of the NGAS Server
-# @param[in] param/ngasPort NGAS Port/7777/Integer/readwrite/
+# @param[in] aparam/ngasPort NGAS Port/7777/Integer/readwrite/False/
 #     \~English The port of the NGAS Server
-# @param[in] param/ngasFileId File ID//String/readwrite/
+# @param[in] aparam/ngasFileId File ID//String/readwrite/False/
 #     \~English File ID on NGAS (for retrieval only)
-# @param[in] param/ngasConnectTimeout Connection timeout/2/Integer/readwrite/
+# @param[in] aparam/ngasConnectTimeout Connection timeout/2/Integer/readwrite/False/
 #     \~English Timeout for connecting to the NGAS server
-# @param[in] param/ngasMime NGAS mime-type/text\/ascii/String/readwrite/
+# @param[in] aparam/ngasMime NGAS mime-type/"text/ascii"/String/readwrite/False/
 #     \~English Mime-type to be used for archiving
-# @param[in] param/ngasTimeout NGAS timeout/2/Integer/readwrite/
+# @param[in] aparam/ngasTimeout NGAS timeout/2/Integer/readwrite/False/
 #     \~English Timeout for receiving responses for NGAS
 # @par EAGLE_END
 class NgasDROP(DataDROP):
@@ -2694,15 +2694,15 @@ def execute(self, _send_notifications=True):
 # @par EAGLE_START
 # @param category Plasma
 # @param tag template
-# @param[in] param/data_volume Data volume/5/Float/readwrite/
+# @param[in] cparam/data_volume Data volume/5/Float/readwrite/False/
 #     \~English Estimated size of the data contained in this node
-# @param[in] param/group_end Group end/False/Boolean/readwrite/
+# @param[in] cparam/group_end Group end/False/Boolean/readwrite/False/
 #     \~English Is this node the end of a group?
-# @param[in] param/plasma_path Plasma Path//String/readwrite/
+# @param[in] aparam/plasma_path Plasma Path//String/readwrite/False/
 #     \~English Path to the local plasma store
-# @param[in] param/object_id Object Id//String/readwrite/
+# @param[in] aparam/object_id Object Id//String/readwrite/False/
 #     \~English PlasmaId of the object for all compute nodes
-# @param[in] param/use_staging Use Staging/False/Boolean/readwrite/
+# @param[in] aparam/use_staging Use Staging/False/Boolean/readwrite/False/
 #     \~English Enables writing to a dynamically resizeable staging buffer
 # @par EAGLE_END
 class PlasmaDROP(AbstractDROP):
@@ -2739,15 +2739,15 @@ def dataURL(self):
 # @par EAGLE_START
 # @param category PlasmaFlight
 # @param tag template
-# @param[in] param/data_volume Data volume/5/Float/readwrite/
+# @param[in] cparam/data_volume Data volume/5/Float/readwrite/False/
 #     \~English Estimated size of the data contained in this node
-# @param[in] param/group_end Group end/False/Boolean/readwrite/
+# @param[in] cparam/group_end Group end/False/Boolean/readwrite/False/
 #     \~English Is this node the end of a group?
-# @param[in] param/plasma_path Plasma Path//String/readwrite/
+# @param[in] aparam/plasma_path Plasma Path//String/readwrite/False/
 #     \~English Path to the local plasma store
-# @param[in] param/object_id Object Id//String/readwrite/
+# @param[in] aparam/object_id Object Id//String/readwrite/False/
 #     \~English PlasmaId of the object for all compute nodes
-# @param[in] param/flight_path Flight Path//String/readwrite/
+# @param[in] aparam/flight_path Flight Path//String/readwrite/False/
 #     \~English IP and flight port of the drop owner
 # @par EAGLE_END
 class PlasmaFlightDROP(AbstractDROP):

daliuge-engine/dlg/parset_drop.py

@@ -33,6 +33,7 @@
 # @details A set of parameters, wholly specified in EAGLE
 # @par EAGLE_START
 # @param category ParameterSet
+# @param tag template
 # @param[in] param/mode Parset mode/"YANDA"/String/readonly/False/To what standard DALiuGE should filter and serialize the parameters.
 # @param[in] param/config_data ConfigData/""/String/readwrite/False/Additional configuration information to be mixed in with the initial data
 # @param[out] port/Config ConfigFile/File/The output configuration file

daliuge-engine/dlg/s3_drop.py

@@ -36,15 +36,15 @@
 # @par EAGLE_START
 # @param category S3
 # @param tag template
-# @param[in] param/data_volume Data volume/5/Float/readwrite/
+# @param[in] cparam/data_volume Data volume/5/Float/readwrite/False/
 #     \~English Estimated size of the data contained in this node
-# @param[in] param/group_end Group end/False/Boolean/readwrite/
+# @param[in] cparam/group_end Group end/False/Boolean/readwrite/False/
 #     \~English Is this node the end of a group?
-# @param[in] param/bucket Bucket//String/readwrite/
+# @param[in] cparam/bucket Bucket//String/readwrite/False/
 #     \~English The S3 Bucket
-# @param[in] param/object_name Object Name//String/readwrite/
+# @param[in] cparam/object_name Object Name//String/readwrite/False/
 #     \~English The S3 Object
-# @param[in] param/profile_name Profile Name//String/readwrite/
+# @param[in] cparam/profile_name Profile Name//String/readwrite/False/
 #     \~English The S3 Profile
 # @par EAGLE_END
 class S3DROP(AbstractDROP):

tools/xml2palette/xml2palette.py

@@ -417,6 +417,7 @@ def create_palette_node_from_params(params):
             # parse description
             if "\n" in value:
                 logging.info(
+                    text + " " +
                     "cparam description ("
                     + value
                     + ") contains a newline character, removing."
@@ -427,7 +428,7 @@ def create_palette_node_from_params(params):
             # check that access is a known value
             if access != "readonly" and access != "readwrite":
                 logging.warning(
-                    "cparam '" + name + "' has unknown 'access' descriptor: " + access
+                    text + " cparam '" + name + "' has unknown 'access' descriptor: " + access
                 )
 
             # add a field
@@ -447,9 +448,16 @@ def create_palette_node_from_params(params):
             (param, internal_name) = parse_key(key)
             (name, default_value, type, access, precious) = parse_param_value(text, "a", value)
 
+            # warn if doc string is still using param instead of aparam
+            if key.startswith("param/"):
+                logging.warning(
+                    text + " param (" + internal_name + ") using obsolete 'param' description, defaulting to 'aparam'"
+                )
+
             # parse description
             if "\n" in value:
                 logging.info(
+                    text + " " +
                     "aparam description ("
                     + value
                     + ") contains a newline character, removing."
@@ -460,7 +468,7 @@ def create_palette_node_from_params(params):
             # check that access is a known value
             if access != "readonly" and access != "readwrite":
                 logging.warning(
-                    "aparam '" + name + "' has unknown 'access' descriptor: " + access
+                    text + " aparam '" + name + "' has unknown 'access' descriptor: " + access
                 )
 
             # add a field