Skip to content

Commit b3ff204

Browse files
committed
minor comments update and unimplemented function removal.
1 parent 51a216b commit b3ff204

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

include/InfoLogger/InfoLogger.hxx

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ class InfoLoggerContext final
7474
/// Update context from current environment information of a different process.
7575
/// This is used internally by command line 'log' utility to tag messages issued by parent process
7676
/// or on stdout by a program which output is piped to stdin of current process and injected in infologger.
77-
/// Fields previously set by user may be overwritten.
77+
/// Fields previously set by user are overwritten.
7878
void refresh(pid_t pid);
7979

8080

@@ -95,13 +95,6 @@ class InfoLoggerContext final
9595
// this simplifies interface to have a single type
9696
// some fields (e.g. run, pid) are stored as integers, but conversion is done by setField
9797
// A field with a blank value (zero-length string) is undefined.
98-
99-
/// Set given field (provided field name and value are strings)
100-
/// \param key The field name to be set. Valid field names are the strings corresponding to what is defined in the FieldName enum: Facility, Role, System, Detector, Partition, Run
101-
/// \param value The value of the field, as a string. This function can be called for any field (string or integer). Conversion will be done whenever needed (string->int).
102-
/// \return 0 on success, an error code otherwise (but never throw exceptions).
103-
int setField(const std::string &key, const std::string &value);
104-
10598

10699

107100
private:
@@ -234,6 +227,7 @@ class InfoLogger
234227

235228
/// Set a field in a message option struct based on its name.
236229
/// If input fieldName valid, and input fieldValue can be parsed, ouput variable is modified accordingly.
230+
/// If fieldValue is blank (zero-length string), the default value is used for the corresponding field.
237231
/// List of valid field names are the strings (1st letter capitalized) corresponding to what is defined in the InfoLoggerMessageOption struct: Severity, Level, ErrorCode, SourceFile, SourceLine
238232
/// \return 0 on success, an error code otherwise.
239233
static int setMessageOption(const char *fieldName, const char *fieldValue, InfoLoggerMessageOption &output);

0 commit comments

Comments
 (0)