aboutsummaryrefslogtreecommitdiffstats
path: root/api/ifcounters/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'api/ifcounters/doc.go')
-rw-r--r--api/ifcounters/doc.go4
1 files changed, 4 insertions, 0 deletions
diff --git a/api/ifcounters/doc.go b/api/ifcounters/doc.go
new file mode 100644
index 0000000..c918941
--- /dev/null
+++ b/api/ifcounters/doc.go
@@ -0,0 +1,4 @@
+// Package ifcounters provides the helper API for decoding VnetInterfaceCounters binary API message
+// that contains binary-encoded statistics data into the Go structs that are better consumable by the Go code.
+// TODO: example usage - currently in the example_client.go
+package ifcounters