about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorFedor Indutny <fedor@indutny.com>2016-05-28 12:36:28 -0400
committerFedor Indutny <fedor@indutny.com>2016-05-28 12:36:28 -0400
commit7d91a2ddcb97dc64ed3bc516829dc00d0f010754 (patch)
tree24a481a8ac37779ba569e45393c28de439f5227f
parent057240cc03fe59700c2c96d5912196b3d4fc98c7 (diff)
downloaduv_link_t-7d91a2ddcb97dc64ed3bc516829dc00d0f010754.tar.gz
api: note about private fields
-rw-r--r--docs/api.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/api.md b/docs/api.md
index 44ad3a2..1779a94 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -5,6 +5,9 @@
 All methods with `int` return value return `0` on success or error code, unless
 specified otherwise.
 
+Fields not listed here a considered private and should not be modified/relied
+upon in user applications.
+
 ## uv_link_t
 
 The base unit of all APIs. Pointer to this structure is what needs to be passed