From d5b529bf636bea41ca11e25a0122b4f308d50b2a Mon Sep 17 00:00:00 2001 From: Hans Ulrich Niedermann Date: Sun, 19 Jun 2005 23:45:33 +0200 Subject: [PATCH] update README.apidocs --- doc/README.apidocs | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/doc/README.apidocs b/doc/README.apidocs index 0d78f7b..9fa4130 100644 --- a/doc/README.apidocs +++ b/doc/README.apidocs @@ -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. -- 2.7.4