Skip to content

Commit

Permalink
Changed enum naming to reflect naming conventions and libplctag langu…
Browse files Browse the repository at this point in the history
…age.

In the libplctag wiki, the language used is
* "Status code", not a "status"
* "Debug level" not a "Debug"
* "Event" not an "Event code"
  • Loading branch information
timyhac committed Jul 17, 2024
1 parent c125282 commit 41aa6ba
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ namespace libplctag.NativeImport
/// There are three ways to set the debug level (for historical reasons):
/// <list type="number">
/// <item>Adding a debug attribute to the attribute string when creating a tag: "protocol=XXX&amp;...&amp;debug=4".</item>
/// <item>Using the <see cref="plctag.plc_tag_set_int_attribute(int, string, int)"/>function to set the debug attribute.</item>
/// <item>Using the <see cref="plctag.plc_tag_set_debug_level(int)"/> function.</item>
/// <item>Using the <see cref="plctag.plc_tag_set_int_attribute"/>function to set the debug attribute.</item>
/// <item>Using the <see cref="plctag.plc_tag_set_debug_level"/> function.</item>
/// </list>
/// The preferred method in code is the last one.
/// </summary>
public enum DEBUG_LEVELS
public enum DEBUG_LEVEL
{
/// <summary>
/// Disables debugging output.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace libplctag.NativeImport
/// The library provides functions to register a callback on a tag.
/// These events generate a call to that callback.
/// </summary>
public enum EVENT_CODES
public enum EVENT
{
/// <summary>
/// A read of the tag has been requested.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace libplctag.NativeImport
/// Most functions return a status code.
/// It will be one of these.
/// </summary>
public enum STATUS_CODES
public enum STATUS_CODE
{
/// <summary>
/// Operation in progress. Not an error.
Expand Down

0 comments on commit 41aa6ba

Please sign in to comment.