summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/prfileprivate.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/nspr/reference/prfileprivate.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/nspr/reference/prfileprivate.rst b/docs/nspr/reference/prfileprivate.rst
new file mode 100644
index 0000000000..dc264d7d85
--- /dev/null
+++ b/docs/nspr/reference/prfileprivate.rst
@@ -0,0 +1,24 @@
+PRFilePrivate
+=============
+
+
+Layer-dependent implementation data.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prio.h>
+
+ typedef struct PRFilePrivate PRFilePrivate;
+
+
+Description
+-----------
+
+A layer implementor should collect all the private data of the layer in
+the :ref:`PRFilePrivate` structure. Each layer has its own definition of
+:ref:`PRFilePrivate`, which is hidden from other layers as well as from the
+users of the layer.