From 3f68923321f8b886aefb4c5a6baf5084b5677c09 Mon Sep 17 00:00:00 2001 From: Pharap Date: Sun, 12 Nov 2017 11:48:19 +0000 Subject: [PATCH] Add more information about defines (#7) --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 6c1fbf9..fbecdbf 100644 --- a/README.md +++ b/README.md @@ -28,9 +28,22 @@ This means: - Any unmodified code must carry the same Apache 2.0 licence. - You may not use any trademarks owned by the licensor. +## Conditional Compilation + +These are symbols you can define prior to library inclusion to alter the behaviour of the library. + +- `FIXED_POINTS_USE_NAMESPACE`: Define this to wrap all classes and functions in the namespace `FixedPoints`. Useful for preventing naming conflicts. + ## Contents This library supplies two core types and sixteen type aliases. +### Defines + +- `FIXED_POINTS_NAMESPACE`: The namespace used by FixedPoints. This is empty unless `FIXED_POINTS_USE_NAMESPACE` is defined prior to inclusion. +- `FIXED_POINTS_DETAILS`: An infrastructure macro that should not be used in user code. It is safe to undefine this if it is causing problems. +- `FIXED_POINTS_BEGIN_NAMESPACE`: An infrastructure macro that should not be used in user code. It is safe to undefine this if it is causing problems. +- `FIXED_POINTS_END_NAMESPACE`: An infrastructure macro that should not be used in user code. It is safe to undefine this if it is causing problems. + ### Core Types: The core types are provided by `FixedPoints.h`.