orastron/brickworks
2
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 10 Wiki Activity

bw_common: remove Brickworks references in doc

Browse Source
This commit is contained in:
Stefano D'Angelo 2024-11-29 14:18:51 +01:00
parent 724d7c6b8a
commit 5015dd6bbd
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
include/bw_common.h
View File

@ -23,7 +23,7 @@
* version {{{ 1.2.0 }}} * version {{{ 1.2.0 }}}
* description {{{ * description {{{
* A common header to make sure that a bunch of basic definitions are * A common header to make sure that a bunch of basic definitions are
* available and consistent for all Brickworks modules. * available and consistent for all modules.
* }}} * }}}
* changelog {{{ * changelog {{{
* <ul> * <ul>
@ -34,6 +34,7 @@
* <code>BW_CXX_NO_EXTERN_C</code>.</li> * <code>BW_CXX_NO_EXTERN_C</code>.</li>
* <li>Allowed custom definitions of <code>BW_NULL</code>.</li> * <li>Allowed custom definitions of <code>BW_NULL</code>.</li>
* <li>Accomodate MSVC reporting incorrect C++ standard support.</li> * <li>Accomodate MSVC reporting incorrect C++ standard support.</li>
* <li>Removed "Brickworks" references in the documentation.</li>
* </ul> * </ul>
* <li>Version <strong>1.1.0</strong>: * <li>Version <strong>1.1.0</strong>:
* <ul> * <ul>
@ -106,37 +107,36 @@
* *
* #### BW_INCLUDE_WITH_QUOTES * #### BW_INCLUDE_WITH_QUOTES
* *
* Normally Brickworks modules include other such modules using angle * Normally, modules include other such modules using angle brackets.
* brackets.
* *
* If you would rather prefer that to happen using double quotes, you can * If you would rather prefer that to happen using double quotes, you can
* define `BW_INCLUDE_WITH_QUOTES`. * define `BW_INCLUDE_WITH_QUOTES`.
* *
* #### BW_NO_CXX * #### BW_NO_CXX
* *
* If `BW_NO_CXX` is defined, the C++ APIs and implementations in Brickworks * If `BW_NO_CXX` is defined, the C++ APIs and implementations in modules
* modules are not included. * are not included.
* *
* #### BW_CXX_NO_EXTERN_C * #### BW_CXX_NO_EXTERN_C
* *
* Normally, the C APIs and implementations in Brickworks modules are * Normally, the C APIs and implementations in modules are included in
* included in <code>extern "C"</code> blocks when using a C++ compiler, even * <code>extern "C"</code> blocks when using a C++ compiler, even if
* if <code>BW_NO_CXX</code> is defined. * <code>BW_NO_CXX</code> is defined.
* *
* If you don't want to have them included in such blocks, you can define * If you don't want to have them included in such blocks, you can define
* `BW_CXX_NO_EXTERN_C`. * `BW_CXX_NO_EXTERN_C`.
* *
* #### BW_CXX_NO_ARRAY * #### BW_CXX_NO_ARRAY
* *
* C++ APIs of Brickworks modules typically include overloaded methods that * C++ APIs in modules typically include overloaded methods that use
* use `std::array` arguments, and thus require the `<array>` header file. * `std::array` arguments, and thus require the `<array>` header file.
* *
* If this is not wanted, defining `BW_CXX_NO_ARRAY` suppresses such methods * If this is not wanted, defining `BW_CXX_NO_ARRAY` suppresses such methods
* and the inclusion of said header file. * and the inclusion of said header file.
* *
* #### Basic definitions * #### Basic definitions
* *
* Brickworks requires definitions of: * Modules require definitions of:
* *
* * `NULL` (C only) and `size_t`, normally supplied by `stddef.h`; * * `NULL` (C only) and `size_t`, normally supplied by `stddef.h`;
* * `(u)int{8,16,32,64}_t`, `INT{8,16,32,64}_{MIN,MAX}`, and * * `(u)int{8,16,32,64}_t`, `INT{8,16,32,64}_{MIN,MAX}`, and