Browse Source

HPCC-17709 STD.System.Log exports are actions, but not indicated as such

Signed-off-by: Richard Chapman <rchapman@hpccsystems.com>
Richard Chapman 8 years ago
parent
commit
e4f88a30a4
1 changed files with 8 additions and 0 deletions
  1. 8 0
      ecllibrary/std/system/Log.ecl

+ 8 - 0
ecllibrary/std/system/Log.ecl

@@ -10,6 +10,8 @@ RETURN MODULE
  * Outputs a line of debug logging to the program log file.
  * 
  * @param text          The text to be added to the log file.
+ *
+ * There is no return value - this is an action
  */
 
 EXPORT dbglog(string text) := lib_logging.Logging.dbglog(text);
@@ -19,6 +21,8 @@ EXPORT dbglog(string text) := lib_logging.Logging.dbglog(text);
  * 
  * @param text          The text to be added to the entry.
  * @param code          An optional code to be associated with the entry.
+ *
+ * There is no return value - this is an action
  */
 
 EXPORT addWorkunitInformation(varstring text, unsigned code=0) := lib_logging.Logging.addWorkunitInformation(text, code);
@@ -28,6 +32,8 @@ EXPORT addWorkunitInformation(varstring text, unsigned code=0) := lib_logging.Lo
  * 
  * @param text          The text of the warning message.
  * @param code          An optional warning code.
+ *
+ * There is no return value - this is an action
  */
 
 EXPORT addWorkunitWarning(varstring text, unsigned code=0) := lib_logging.Logging.addWorkunitWarning(text, code);
@@ -37,6 +43,8 @@ EXPORT addWorkunitWarning(varstring text, unsigned code=0) := lib_logging.Loggin
  * 
  * @param text          The text of the error message.
  * @param code          An optional error code.
+ *
+ * There is no return value - this is an action
  */
 
 EXPORT addWorkunitError(varstring text, unsigned code=0) := lib_logging.Logging.addWorkunitError(text, code, 2);