diff options
author | Peter Hutterer <peter.hutterer@who-t.net> | 2009-05-16 11:49:21 +1000 |
---|---|---|
committer | Peter Hutterer <peter.hutterer@who-t.net> | 2009-05-16 11:49:35 +1000 |
commit | 8c2872367765170c37f829d635c97dc3d68861b7 (patch) | |
tree | 5f6c378bcfbaab4b754444686ff13e51eeead9b6 /XI2proto.h | |
parent | b32e5830c0acbdba4798fad107bf8404c978753c (diff) |
Document naming conventions for XI2proto.h.
Diffstat (limited to 'XI2proto.h')
-rw-r--r-- | XI2proto.h | 26 |
1 files changed, 26 insertions, 0 deletions
@@ -22,10 +22,36 @@ * */ +/* Conventions for this file: + * Names: + * structs: always typedef'd, prefixed with xXI, CamelCase + * struct members: lower_case_with_underscores + * Exceptions: reqType, ReqType, repType, RepType, sequenceNumber are + * named as such for historical reasons. + * request opcodes: X_XIRequestName as CamelCase + * defines: defines used in client applications must go in XI2.h + * defines used only in protocol handling: XISOMENAME + * + * Data types: unless there is a historical name for a datatype (e.g. + * Window), use stdint types specifying the size of the datatype. + * historical data type names must be defined and undefined at the top and + * end of the file. + * + * General: + * spaces, not tabs. + * structs specific to a request or reply added before the request + * definition. structs used in more than one request, reply or event + * appended to the common structs section before the definition of the + * first request. + * members of structs vertically aligned on column 16 if datatypes permit. + * otherwise alingned on next available 8n column. + */ + /** * @mainpage * @include XI2proto.txt */ + /** * @file XI2proto.h * Protocol definitions for the XI2 protocol. |