diff options
| author | Jon Atack <jon@atack.com> | 2022-05-06 18:29:18 +0200 |
|---|---|---|
| committer | Jon Atack <jon@atack.com> | 2022-05-09 16:14:04 +0200 |
| commit | 5fca70f5b16fee4a732a1d7fd3fb1c7e775decdf (patch) | |
| tree | 4c2d456444e7935bb92f740b0dc91bf228c7f6fb /doc | |
| parent | fc4cb857ccfa622e76f0f8e7aa164ca4d8bd599a (diff) | |
Link in developer notes style to internal interface exception
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer-notes.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/developer-notes.md b/doc/developer-notes.md index 00fa0825a8..ab2a899dd7 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -96,7 +96,10 @@ code. Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Renum-caps), which recommend using `snake_case`. Please use what seems appropriate. - Class names, function names, and method names are UpperCamelCase - (PascalCase). Do not prefix class names with `C`. + (PascalCase). Do not prefix class names with `C`. See [Internal interface + naming style](#internal-interface-naming-style) for an exception to this + convention. + - Test suite naming convention: The Boost test suite in file `src/test/foo_tests.cpp` should be named `foo_tests`. Test suite names must be unique. @@ -1416,6 +1419,8 @@ communication: virtual bool disconnect(NodeId id) = 0; ``` +### Internal interface naming style + - For consistency and friendliness to code generation tools, interface method names should be `lowerCamelCase` and standalone function names should be `UpperCamelCase`. |