-
Notifications
You must be signed in to change notification settings - Fork 6
Open
Labels
A-coreArea: The core library (rayx-core)Area: The core library (rayx-core)A-docsArea: Project documentationArea: Project documentationA-metaArea: development environment (toolchain, repo, etc.)Area: development environment (toolchain, repo, etc.)
Description
since many things are defined in header files, users inevitably import symbols, that are not meant to be visible from the outside.
this is a common problem in c++.
other libraries often put 'private' symbols into an extra namespace (e.g. detail
)
namespace detail {
void someFunctionThatIsPrivateToRayxCore();
}
void somePublicFunction() {
detail::someFunctionThatIsPrivateToRayxCore(); // still accessible
}
this method does not inhibit access to 'private' functions. it rather informs the user, that symbols inside namespace detail
are not meant to be part of the API
NOTE: this method could help DOXYGEN to separate the API that we expose
Metadata
Metadata
Assignees
Labels
A-coreArea: The core library (rayx-core)Area: The core library (rayx-core)A-docsArea: Project documentationArea: Project documentationA-metaArea: development environment (toolchain, repo, etc.)Area: development environment (toolchain, repo, etc.)