From: <tho...@fr...> - 2005-10-28 16:54:29
|
CVS Root: /cvs/gstreamer Module: gstreamer Changes by: thomasvs Date: Fri Oct 28 2005 09:54:27 PDT Log message: some style fixes Modified files: docs : README Links: http://freedesktop.org/cgi-bin/viewcvs.cgi/gstreamer/gstreamer/docs/README.diff?r1=1.15&r2=1.16 ====Begin Diffs==== Index: README =================================================================== RCS file: /cvs/gstreamer/gstreamer/docs/README,v retrieving revision 1.15 retrieving revision 1.16 diff -u -d -r1.15 -r1.16 --- README 28 Oct 2005 16:08:52 -0000 1.15 +++ README 28 Oct 2005 16:54:15 -0000 1.16 @@ -190,12 +190,16 @@ 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) |