patch [#34103] Add explanatory comments to dna_genfile.[ch]

from Lawrence D'Oliveiro (ldo)

1 files changed, 7 insertions, 3 deletions

diff --git a/source/blender/makesdna/DNA_genfile.h b/source/blender/makesdna/DNA_genfile.h
index 2d1549ff487..ac75b03c742 100644
--- a/source/blender/makesdna/DNA_genfile.h
+++ b/source/blender/makesdna/DNA_genfile.h
@@ -35,9 +35,13 @@
 
 struct SDNA;
 
-extern const unsigned char DNAstr[];  /* DNA.c */
-extern const int DNAlen;
+/* DNAstr contains the prebuilt SDNA structure defining the layouts of the types
+ * used by this version of Blender. It is defined in a file dna.c, which is
+ * generated by the makesdna program during the build process (see makesdna.c). */
+extern const unsigned char DNAstr[];
+extern const int DNAlen; /* length of DNAstr */
 
+/* primitive (non-struct, non-pointer/function/array) types--do not change ordering! */
 typedef enum eSDNA_Type {
 	SDNA_TYPE_CHAR     = 0,
 	SDNA_TYPE_UCHAR    = 1,
@@ -56,7 +60,7 @@ typedef enum eSDNA_Type {
 /* define so switch statements don't complain */
 #define SDNA_TYPE_VOID 9
 
-struct SDNA *DNA_sdna_from_data(const void *data, const int datalen, int do_endian_swap);
+struct SDNA *DNA_sdna_from_data(const void *data, const int datalen, bool do_endian_swap);
 void DNA_sdna_free(struct SDNA *sdna);
 
 int DNA_struct_find_nr(struct SDNA *sdna, const char *str);