From 201e8082ad698ee81eae04d845112f943dd8005d Mon Sep 17 00:00:00 2001 From: Thomas Vander Stichele Date: Fri, 28 Oct 2005 16:54:15 +0000 Subject: [PATCH] some style fixes Original commit message from CVS: some style fixes --- docs/README | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/README b/docs/README index 3e5b55876e..35b1196fa8 100644 --- a/docs/README +++ b/docs/README @@ -190,12 +190,16 @@ STYLE GUIDE FOR GTK-DOC top - functions that can return FALSE/NULL or fail should describe their failure conditions like this: - * Returns NULL if: - * - no element with the given name is found in the bin + * Returns NULL if no element with the given name is found in the bin, if + * the frobble was stuck in the froob, or the frizzle was frazzed. - a line with function attributes should be added before Returns: - can contain: "MT safe." - the function is verified to be multithreadingsafe - "Caller owns returned reference" + "Caller owns returned reference" for refcounted classes + "Caller owns returned value" for other types (iterators, ..) + - we do this because, in contrast with GLib/GTK, we are more explicit + about threadsafety and related issues + - the bottom of the description should say when the doc was last reviewed (version and date) * Last reviewed on 2005-10-28 (0.9.4)