Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: optimized struct-entry comments #9

Merged
merged 1 commit into from
Sep 18, 2023
Merged

doc: optimized struct-entry comments #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 10 additions & 20 deletions src/TcLogProj/TcLog/Logger/_DataTypes/LoggingConfiguration.TcDUT
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,16 @@
<Declaration><![CDATA[/// Configuration of TcLogCore
TYPE LoggingConfiguration :
STRUCT
/// File name where the logs should be written to. Should not include path.
FileName : Tc2_System.T_MaxString;
/// File path where the logs should be written to. Will be prefixed to `FileName`
FilePath : Tc2_System.T_MaxString;
/// Whether to include the instance path of TcLog into the log message or not.
IncludeInstancePath : BOOL;
/// Whether to write the logs to ADS output or not.
WriteToAds : BOOL;
/// Rolling interval: when to create a new log file.
RollingInterval : RollingIntervals;
/// What is the minimum log level that gets logged?
MinimumLevel : LogLevels;
/// Which delimiter should be used between the different parts of the log string?
Delimiter : STRING(1);
/// When should old log files be deleted? Unit: days. Set it to `0` if log files should never be deleted.
LogFileLifespan : UINT;
/// Format of timestamp. See `TcLogCore.TimestampFormat` for formatting options.
TimestampFormat : STRING;
FileName : Tc2_System.T_MaxString; //< File name where the logs should be written to. Should not include path.
FilePath : Tc2_System.T_MaxString; //< File path where the logs should be written to. Will be prefixed to `FileName`
IncludeInstancePath : BOOL; //< Whether to include the instance path of TcLog into the log message or not.
WriteToAds : BOOL; //< Whether to write the logs to ADS output or not.
RollingInterval : RollingIntervals; //< Rolling interval: when to create a new log file.
MinimumLevel : LogLevels; //< What is the minimum log level that gets logged?
Delimiter : STRING(1); //< Which delimiter should be used between the different parts of the log string?
LogFileLifespan : UINT; //< When should old log files be deleted? Unit: days. Set it to `0` if log files should never be deleted.
TimestampFormat : STRING; //< Format of timestamp. See `TcLogCore.TimestampFormat` for formatting options.
END_STRUCT
END_TYPE
]]></Declaration>
END_TYPE]]></Declaration>
</DUT>
</TcPlcObject>