mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-12-23 16:50:47 +00:00
Code Issues 1 Projects Releases Wiki Activity

some style fixes

Browse source 
Original commit message from CVS:
some style fixes
This commit is contained in:
Thomas Vander Stichele 2005-10-28 16:54:15 +00:00
parent 0572e3c3ae
commit 201e8082ad
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/README
View file

@ -190,12 +190,16 @@ STYLE GUIDE FOR GTK-DOC
top top
- functions that can return FALSE/NULL or fail should describe their failure - functions that can return FALSE/NULL or fail should describe their failure
conditions like this: conditions like this:
* Returns NULL if: * Returns NULL if no element with the given name is found in the bin, if
* - no element with the given name is found in the bin * the frobble was stuck in the froob, or the frizzle was frazzed.
- a line with function attributes should be added before Returns: - a line with function attributes should be added before Returns:
- can contain: - can contain:
"MT safe." - the function is verified to be multithreadingsafe "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 - the bottom of the description should say when the doc was last reviewed
(version and date) (version and date)
* Last reviewed on 2005-10-28 (0.9.4) * Last reviewed on 2005-10-28 (0.9.4)