update README.apidocs
authorHans Ulrich Niedermann <hun@n-dimensional.de>
Sun, 19 Jun 2005 21:45:33 +0000 (23:45 +0200)
committerHans Ulrich Niedermann <hun@n-dimensional.de>
Sun, 19 Jun 2005 21:45:33 +0000 (23:45 +0200)
doc/README.apidocs

index 0d78f7b..9fa4130 100644 (file)
@@ -1,8 +1,7 @@
 Rules for the API docs:
 
-  1. DO NOT DOCUMENT ANYTHING YET
-  2. If you know a method to keep API docs and internal docs apart, with
-     doxygen, please tell us.
+  1. Clearly distinguish between interna and the external API/ABI.
+  2. Mark internal stuff with \internal.
   3. If this has been solved, start documenting the external interface.
 
 Thank you.