Skip to content

Commit 5fca70f

Browse files
committed
Link in developer notes style to internal interface exception
1 parent fc4cb85 commit 5fca70f

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

doc/developer-notes.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,10 @@ code.
9696
Guidelines](https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Renum-caps),
9797
which recommend using `snake_case`. Please use what seems appropriate.
9898
- Class names, function names, and method names are UpperCamelCase
99-
(PascalCase). Do not prefix class names with `C`.
99+
(PascalCase). Do not prefix class names with `C`. See [Internal interface
100+
naming style](#internal-interface-naming-style) for an exception to this
101+
convention.
102+
100103
- Test suite naming convention: The Boost test suite in file
101104
`src/test/foo_tests.cpp` should be named `foo_tests`. Test suite names
102105
must be unique.
@@ -1416,6 +1419,8 @@ communication:
14161419
virtual bool disconnect(NodeId id) = 0;
14171420
```
14181421
1422+
### Internal interface naming style
1423+
14191424
- For consistency and friendliness to code generation tools, interface method
14201425
names should be `lowerCamelCase` and standalone function names should be
14211426
`UpperCamelCase`.

0 commit comments

Comments
 (0)