some hint updates

Original commit message from CVS:
some hint updates
This commit is contained in:
Thomas Vander Stichele 2002-08-30 16:02:45 +00:00
parent 56c8649f39
commit 8cfb8350b8

View file

@ -11,6 +11,9 @@ Documentation review
* Style * Style
- when in doubt, try to conform to GTK+ reference docs - when in doubt, try to conform to GTK+ reference docs
(in the gtk-doc tarball, doc/style-guide.txt)
- GtkMisc and GtkFontSelectionDialog are example templates.
- in the arg clarification, use as much cross-reffing as possible. Do it - in the arg clarification, use as much cross-reffing as possible. Do it
only where it is useful in the explanation text. only where it is useful in the explanation text.
@ -18,9 +21,17 @@ Documentation review
- use active form instead of imperative describing functions; we describe - use active form instead of imperative describing functions; we describe
what the function does. what the function does.
good : creates a new buffer good : creates a new buffer.
bad : create new buffer bad : create new buffer
- use singular for enum names; this makes it more natural to reference to - use singular for enum names; this makes it more natural to reference to
it in the API docs it in the API docs
good : GstBufferFlag good : GstBufferFlag
bad : GstBufferFlags bad : GstBufferFlags
- in arg clarification, use a period and start with a small letter.
Call the object you work on "a" instead of "the". Call the other objects
"the".
If the object in question is the return value, this means you call the
return value "a". If the object in question is the first argument
of the call, you call this argument "a" and the rest "the".
good : @buf: a pointer to query.
bad : @buf: The pointer to query