mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-10-04 17:52:29 +00:00
design: conventions: fix missing markup & drop needless escaping
This commit is contained in:
parent
5f1ce5aa5d
commit
fee2433e04
1 changed files with 6 additions and 6 deletions
|
@ -10,15 +10,15 @@ long as context is rigorously observed.
|
||||||
## Object classes
|
## Object classes
|
||||||
|
|
||||||
Since everything starts with Gst, we will generally refer to objects by
|
Since everything starts with Gst, we will generally refer to objects by
|
||||||
the shorter name, i.e. Element or Pad. These names will always have
|
the shorter name, i.e. `Element` or `Pad`. These names will always have
|
||||||
their first letter capitalized.
|
their first letter capitalized.
|
||||||
|
|
||||||
## Function names
|
## Function names
|
||||||
|
|
||||||
Within the context of a given object, functions defined in that object’s
|
Within the context of a given object, functions defined in that object’s
|
||||||
header and/or source file will have their object-specific prefix
|
header and/or source file will have their object-specific prefix
|
||||||
stripped. For instance, gst\_element\_add\_pad() would be referred to as
|
stripped. For instance, `gst_element_add_pad()` would be referred to as
|
||||||
simply *add\_pad(). Note that the trailing parentheses should always be
|
simply `*add_pad()`. Note that the trailing parentheses should always be
|
||||||
present, but sometimes may not be. A prefixing underscore (*) will
|
present, but sometimes may not be. A prefixing underscore (*) will
|
||||||
always tell you it’s a function, however, regardless of the presence or
|
always tell you it’s a function, however, regardless of the presence or
|
||||||
absence of the trailing parentheses.
|
absence of the trailing parentheses.
|
||||||
|
@ -28,12 +28,12 @@ absence of the trailing parentheses.
|
||||||
Values and macros defined as enums and preprocessor macros will be
|
Values and macros defined as enums and preprocessor macros will be
|
||||||
referred to in all capitals, as per their definition. This includes
|
referred to in all capitals, as per their definition. This includes
|
||||||
object flags and element states, as well as general enums. Examples are
|
object flags and element states, as well as general enums. Examples are
|
||||||
the states NULL, READY, PLAYING, and PAUSED; the element flags
|
the states `NULL`, `READY`, `PLAYING`, and `PAUSED`; the element flags
|
||||||
LOCKED\_STATE , and state return values SUCCESS, FAILURE, and ASYNC.
|
`LOCKED_STATE`, and state return values `SUCCESS`, `FAILURE`, and `ASYNC`.
|
||||||
Where there is a prefix, as in the element flags, it is usually dropped
|
Where there is a prefix, as in the element flags, it is usually dropped
|
||||||
and implied. Note however that element flags should be cross-checked
|
and implied. Note however that element flags should be cross-checked
|
||||||
with the header, as there are currently two conventions in use: with and
|
with the header, as there are currently two conventions in use: with and
|
||||||
without *FLAGS* in the middle.
|
without `*FLAGS*` in the middle.
|
||||||
|
|
||||||
## Drawing conventions
|
## Drawing conventions
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue