Skip to content

Code guidelines: anonymous namespace - enhancement #1034

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 27, 2019
Merged

Code guidelines: anonymous namespace - enhancement #1034

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f37468
Update design_guidelines.md
GuyWi Mar 27, 2019
15fba93
Update design_guidelines.md
GuyWi Mar 27, 2019
e254a68
Update design_guidelines.md
GuyWi Mar 27, 2019
fae405a
Tweak word in design_guidelines.md
Mar 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/reference/contributing/guidelines/design_guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ The Arm Mbed OS codebase is organized into conceptual submodules to limit the sc
- As an entry point for the module (from the user space), we suggest a single header file. For example: `mbed.h`, `rtos.h`.
- Header files should limit external includes to avoid indirectly exposing unrelated APIs. Header files should not expand namespaces.
- In C++ modules, the API should be contained in a namespace that matches the module’s name. For example: `mbed::Ticker`, `rtos::Thread`, `netsocket::Socket`.
- Define the internal class types in each C++ module inside an anonymous namespace. In C++, you cannot have different definitions of the same class name in different source files, even if they are not externally visible. In practice, a name collision often doesn't cause a problem; however, it can cause a build failure when link time optimization (LTO) is enabled, or a runtime failure if templates are instantiated using the internal classes.
- In C modules, every nonstatic function and type should be prefixed with the module’s name followed by an underscore. For example: `mbed_critical_section_enter()`, `lwip_gethostbyname(host)`.
- A module contained in the Mbed OS codebase may be mirrored in a separate repo. The source repo should be clearly identified and linked to from the module's README.
- Special directories should follow consistent naming convention.
Expand Down