diff options
| author | Tor Andersson <tor.andersson@artifex.com> | 2016-10-21 12:17:06 +0200 |
|---|---|---|
| committer | Tor Andersson <tor.andersson@artifex.com> | 2016-10-21 12:17:40 +0200 |
| commit | 92900198b45475e78a9b108dc4e6b2a8e5852a52 (patch) | |
| tree | 33b9a075b4b8441a93530202a5222b5313ccf81f /docs | |
| parent | 12134a5beb735ba1a5ee74b7fe8145d40edb0d55 (diff) | |
| download | mupdf-92900198b45475e78a9b108dc4e6b2a8e5852a52.tar.xz | |
Update docs/naming.txt
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/naming.txt | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/naming.txt b/docs/naming.txt index 6c641c33..03ab3e4c 100644 --- a/docs/naming.txt +++ b/docs/naming.txt @@ -7,6 +7,8 @@ Functions should be named according to one of the following schemes: get_noun_attribute -- when the 'noun_attribute' name conflicts with a type set_noun_attribute + noun_from_noun -- convert from one type to another (avoid noun_to_noun) + Prefixes are mandatory for exported functions, macros, enums, globals and types. fz for common code @@ -20,7 +22,7 @@ These words are reserved for reference counting schemes: new, find, load, open, keep -- return objects that you are responsible for freeing. - drop, free, close -- relinquish ownership of the object passed in. + drop -- relinquish ownership of the object passed in. When searching for an object or value, the name used depends on whether returning the value is passing ownership: |