Docs: improve wording for dna_defaults.c descriptions

This commit is contained in:
Campbell Barton
2024-12-03 22:17:30 +11:00
parent 3b303bed34
commit b48c81761f

View File

@@ -24,7 +24,8 @@
* To create these defaults there is a GDB script which can be handy to get started:
* `./tools/utils/gdb_struct_repr_c99.py`
*
* Magic numbers should be replaced with flags before committing.
* Magic numbers should be replaced with human readable values before committing,
* typically enums or preprocessor defined values.
*
* \note Defaults must be registered by adding the #SDNA_DEFAULT_DECL_STRUCT and
* #SDNA_DEFAULT_DECL macro calls to the lists below.
@@ -38,7 +39,8 @@
*
* These access the struct table #DNA_default_table using the struct number.
*
* \note Struct members only define their members (pointers are left as NULL set).
* \note Struct defaults only define members stored directly in the struct,
* pointers are set to null.
*
* Typical Usage
* -------------