diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/memtypes.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/developer/memtypes.rst b/doc/developer/memtypes.rst index 153131bab..13f6b43bb 100644 --- a/doc/developer/memtypes.rst +++ b/doc/developer/memtypes.rst @@ -42,6 +42,16 @@ Example: Definition ---------- +.. c:type:: struct memtype + + This is the (internal) type used for MTYPE definitions. The macros below + should be used to create these, but in some cases it is useful to pass a + ``struct memtype *`` pointer to some helper function. + + The ``MTYPE_name`` created by the macros is declared as an array, i.e. + a function taking a ``struct memtype *`` argument can be called with an + ``MTYPE_name`` argument (as opposed to ``&MTYPE_name``.) + .. c:macro:: DECLARE_MGROUP(name) This macro forward-declares a memory group and should be placed in a |