summaryrefslogtreecommitdiff
path: root/doc/README.apidocs
diff options
context:
space:
mode:
Diffstat (limited to 'doc/README.apidocs')
-rw-r--r--doc/README.apidocs7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/README.apidocs b/doc/README.apidocs
new file mode 100644
index 0000000..4486f5d
--- /dev/null
+++ b/doc/README.apidocs
@@ -0,0 +1,7 @@
+Rules for the API docs:
+
+ 1. Clearly distinguish between internal and the external API/ABI.
+ 2. Mark internal stuff with \internal.
+ 3. If this has been solved, start documenting the external interface.
+
+Thank you.