summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRichard Braun <rbraun@sceen.net>2017-09-05 21:11:56 +0200
committerRichard Braun <rbraun@sceen.net>2017-09-05 21:11:56 +0200
commit1d6ea814d13a05fd4d64e0764acf667f67679092 (patch)
tree46e3d713d3e559e41018a19f7065ad96f4bcca47
parent429fa916855575e10244245a100120ad2777cc8a (diff)
doc/style(9): add build and cleanup to the common function names
-rw-r--r--doc/style.9.txt11
1 files changed, 7 insertions, 4 deletions
diff --git a/doc/style.9.txt b/doc/style.9.txt
index be59024f..1b5108fe 100644
--- a/doc/style.9.txt
+++ b/doc/style.9.txt
@@ -511,12 +511,15 @@ for the most common operations.
*setup*::
This function is used for module initialization.
*init*::
- Object initialization, without memory allocation. Object initialization
- should normally never fail.
+ Object initialization that may not fail (e.g. without memory allocation).
+*build*::
+ Object construction, i.e. initialization that may fail.
+*cleanup*::
+ Object clean-up, releasing internal resources but not the object itself.
*create*::
- Object creation, including both allocation and initialization.
+ Object creation, including both allocation and construction.
*destroy*::
- Object destruction.
+ Object destruction, releasing all resources including the object itself.
*ref*::
Add a reference to an object.
*unref*::