This commit is contained in:
2020-08-10 17:28:32 +02:00
parent fbb4d8ad2e
commit d49e627f5d
89 changed files with 1832 additions and 1250 deletions

View File

@@ -34,33 +34,6 @@ DigitalData.Modules.Logging
<dependencies>
NLog, >= 4.5.8
</dependencies>
<params>
logPath, PathType
The basepath to write logs to. Can be AppData, CurrentDirectory or CustomPath.
- AppData: writes to local application data directory
- CurrentDirectory: writes to `Log` directory relative to the current directory
- CustomPath: writes to custom path specified in `customLogPath`
customLogPath, String (optional)
If `logPath` is set to custom, this defines the custom logPath.
suffix, String (optional)
If set to anything other than Nothing, extends the logfile name with this suffix.
</params>
<props>
LogFile, String (readonly)
Returns the full path of the default log file.
LogPath, String (readonly)
Returns the path to the log directory.
LogFactory, NLog.LogFactory (readonly)
Returns the LogFactory that is used to create the Logger object
Debug, Boolean
Determines if the debug log should be written.
</props>
<example>
Imports DigitalData.Modules.Logging
@@ -132,13 +105,15 @@ DigitalData.Modules.Logging
</summary>
<returns>A list of log messages</returns>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.#ctor(DigitalData.Modules.Logging.LogConfig.PathType,System.String,System.String)">
<member name="M:DigitalData.Modules.Logging.LogConfig.#ctor(DigitalData.Modules.Logging.LogConfig.PathType,System.String,System.String,System.String,System.String)">
<summary>
Initializes a new LogConfig object with a logpath and optinally a filename-suffix.
</summary>
<param name="logPath">The basepath to write logs to. Can be AppData, CurrentDirectory or CustomPath.</param>
<param name="customLogPath">If `logPath` is set to custom, this defines the custom logPath.</param>
<param name="suffix">If set to anything other than Nothing, extends the logfile name with this suffix.</param>
<param name="LogPath">The basepath to write logs to. Can be AppData, CurrentDirectory or CustomPath.</param>
<param name="CustomLogPath">If `logPath` is set to custom, this defines the custom logPath.</param>
<param name="Suffix">If set to anything other than Nothing, extends the logfile name with this suffix.</param>
<param name="CompanyName">CompanyName is used to construct log-path in when LogPath is set to PathType:AppData</param>
<param name="ProductName">ProductName is used to construct log-path in when LogPath is set to PathType:AppData</param>
</member>
<member name="M:DigitalData.Modules.Logging.LogConfig.GetLogger">
<summary>