diff options
Diffstat (limited to 'source/blender/blenloader/BLO_read_write.h')
-rw-r--r-- | source/blender/blenloader/BLO_read_write.h | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/source/blender/blenloader/BLO_read_write.h b/source/blender/blenloader/BLO_read_write.h index 86c7c367816..be5d28c7716 100644 --- a/source/blender/blenloader/BLO_read_write.h +++ b/source/blender/blenloader/BLO_read_write.h @@ -69,28 +69,28 @@ struct ReportList; * DNA Struct Writing * ------------------ * - * Functions dealing with DNA structs begin with BLO_write_struct_*. + * Functions dealing with DNA structs begin with `BLO_write_struct_*`. * * DNA struct types can be identified in different ways: - * - Run-time Name: The name is provided as const char *. - * - Compile-time Name: The name is provided at compile time. This is more efficient. - * - Struct ID: Every DNA struct type has an integer ID that can be queried with - * BLO_get_struct_id_by_name. Providing this ID can be a useful optimization when many structs - * of the same type are stored AND if those structs are not in a continuous array. + * - Run-time Name: The name is provided as `const char *`. + * - Compile-time Name: The name is provided at compile time. This is more efficient. + * - Struct ID: Every DNA struct type has an integer ID that can be queried with + * #BLO_get_struct_id_by_name. Providing this ID can be a useful optimization when many + * structs of the same type are stored AND if those structs are not in a continuous array. * * Often only a single instance of a struct is written at once. However, sometimes it is necessary * to write arrays or linked lists. Separate functions for that are provided as well. * - * There is a special macro for writing id structs: BLO_write_id_struct. Those are handled - * differently from other structs. + * There is a special macro for writing id structs: #BLO_write_id_struct. + * Those are handled differently from other structs. * * Raw Data Writing * ---------------- * - * At the core there is BLO_write_raw, which can write arbitrary memory buffers to the file. The - * code that reads this data might have to correct its byte-order. For the common cases there are - * convenience functions that write and read arrays of simple types such as int32. Those will - * correct endianness automatically. + * At the core there is #BLO_write_raw, which can write arbitrary memory buffers to the file. + * The code that reads this data might have to correct its byte-order. For the common cases + * there are convenience functions that write and read arrays of simple types such as `int32`. + * Those will correct endianness automatically. */ /* Mapping between names and ids. */ |