mirrors/monado
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/monado/monado.git synced 2025-01-01 12:46:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: Update conventions

Browse source
This commit is contained in:
Ryan Pavlik 2022-04-12 16:35:08 -05:00 committed by Jakob Bornecrantz
parent 029fa2496e
commit d37f54f179
1 changed files with 1 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/conventions.md
View file

@ -85,7 +85,6 @@ directed-acyclic-graph.
- Where a C API is exposed, it should follow the C API naming schemes. - Where a C API is exposed, it should follow the C API naming schemes.
- If only a C++ API is exposed, a fairly conventional C++ naming scheme is used: - If only a C++ API is exposed, a fairly conventional C++ naming scheme is used:
- Namespaces: nested to match directory structure, starting with `xrt::`. - Namespaces: nested to match directory structure, starting with `xrt::`.
(Migration to this pattern is still in progress.)
- There are no C++ interfaces in the `xrt/include/xrt`, by design, so this - There are no C++ interfaces in the `xrt/include/xrt`, by design, so this
is not ambiguous. is not ambiguous.
- Place types that need to be exposed in a header for technical reasons, - Place types that need to be exposed in a header for technical reasons,
@ -94,6 +93,7 @@ directed-acyclic-graph.
ecosystem. ecosystem.
- Types/classes: `CamelCase` - Types/classes: `CamelCase`
- Methods/functions: `lowerCamelCase` - Methods/functions: `lowerCamelCase`
- Constants/constexpr values: `kCamelCase`
- If a header is only usable from C++ code, it should be named with the - If a header is only usable from C++ code, it should be named with the
extension `.hpp` to signify this. extension `.hpp` to signify this.