mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-02-17 03:35:21 +00:00
remarks for doc review
Original commit message from CVS: remarks for doc review
This commit is contained in:
parent
d2af387684
commit
243d255d57
1 changed files with 26 additions and 0 deletions
26
docs/random/thomasvs/docreview
Normal file
26
docs/random/thomasvs/docreview
Normal file
|
@ -0,0 +1,26 @@
|
|||
Documentation review
|
||||
|
||||
* gstbuffer
|
||||
- What are the flags in GstBuffer ? used anywhere ? defined how ?
|
||||
|
||||
|
||||
* General
|
||||
- how can we define common terms and make them cros-ref'd ?
|
||||
e.g. timestamps in buffer, do we say everywhere that they're in nanosec ?
|
||||
|
||||
|
||||
* Style
|
||||
- when in doubt, try to conform to GTK+ reference docs
|
||||
- in the arg clarification, use as much cross-reffing as possible. Do it
|
||||
only where it is useful in the explanation text.
|
||||
|
||||
- examples
|
||||
|
||||
- use active form instead of imperative describing functions; we describe
|
||||
what the function does.
|
||||
good : creates a new buffer
|
||||
bad : create new buffer
|
||||
- use singular for enum names; this makes it more natural to reference to
|
||||
it in the API docs
|
||||
good : GstBufferFlag
|
||||
bad : GstBufferFlags
|
Loading…
Reference in a new issue