*** empty log message ***
[m17n/m17n-lib.git] / src / README
1 Naming convention.
2
3 name-space              internal        external
4 ==========              ========        ========
5 function                mobject__xxx    mobject_xxx
6 symbol variable         Mobject__xxx    Mobject_xxx
7 other variable          mobject__xxx    mobject_xxx
8 constant macro                  MOBJECT_XXX
9 other macro                     MOBJECT_XXX
10 type                            MObject[Xxx]
11
12 A structure is named as MXxxxx and is `typedef'ed with the same name.
13 Ex: typedef struct MFace MFace
14
15 In comments, a structure member is denoted simply as `<member_name>',
16 but a member of a specific structure is denoted as
17 `MStruct->member_name'.  If the member itself is a structure (or a
18 pointer to a structure) and has a sub-member, the sub-member is
19 denoted as:
20         `<member_name.sub_name>'
21         or `<member_name->sub_name>'
22         or `MStruct->member_name.subname'
23         or `MStruct->member_name->subname'