summaryrefslogtreecommitdiff
path: root/src/docs/namespace.dox
blob: a307185c93e7bc0a7c218a6da7880a1c67f5dc1d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/*! @page name_space Name spaces

@section env Process' environment name space

WiredTiger's environment variables begin with the string "WIREDTIGER".

@section c C language name space

WiredTiger's public function names begin with the string "wiredtiger".

WiredTiger's public \c \#define and structure \c typedef declarations
begin with the string "WT_".

WiredTiger's private function names begin with the string "__wt_".

@section filename File system name space

WiredTiger's files begin with the string "WiredTiger"; applications
should not create files in the WiredTiger file system name space.

@section error Error return name space

WiredTiger reserves all values from -31,800 to -31,999 as possible error
return values.

*/