[Bf-blender-cvs] [4040cb438f8] master: Cleanup: use doxy sections for BLI read/write headers

[Campbell Barton]

Commit: 4040cb438f8929da6a1c29ba7c9c8288c1f05a5a
Author: Campbell Barton
Date:   Tue Jun 23 16:38:52 2020 +1000
Branches: master
https://developer.blender.org/rB4040cb438f8929da6a1c29ba7c9c8288c1f05a5a

Cleanup: use doxy sections for BLI read/write headers

Add reference between the read/write functions too.

===================================================================

M	source/blender/blenloader/BLO_readfile.h
M	source/blender/blenloader/BLO_writefile.h

===================================================================

diff --git a/source/blender/blenloader/BLO_readfile.h b/source/blender/blenloader/BLO_readfile.h
index 8495caa91b5..e4908eb7257 100644
--- a/source/blender/blenloader/BLO_readfile.h
+++ b/source/blender/blenloader/BLO_readfile.h
@@ -48,6 +48,18 @@ struct wmWindowManager;
 
 typedef struct BlendHandle BlendHandle;
 
+typedef struct WorkspaceConfigFileData {
+  struct Main *main; /* has to be freed when done reading file data */
+
+  struct ListBase workspaces;
+} WorkspaceConfigFileData;
+
+/* -------------------------------------------------------------------- */
+/** \name BLO Read File API
+ *
+ * \see #BLO_write_file for file writing.
+ * \{ */
+
 typedef enum eBlenFileType {
   BLENFILETYPE_BLEND = 1,
   /* BLENFILETYPE_PUB = 2, */     /* UNUSED */
@@ -69,12 +81,6 @@ typedef struct BlendFileData {
   eBlenFileType type;
 } BlendFileData;
 
-typedef struct WorkspaceConfigFileData {
-  struct Main *main; /* has to be freed when done reading file data */
-
-  struct ListBase workspaces;
-} WorkspaceConfigFileData;
-
 struct BlendFileReadParams {
   uint skip_flags : 3; /* eBLOReadSkip */
   uint is_startup : 1;
@@ -108,6 +114,12 @@ BlendFileData *BLO_read_from_memfile(struct Main *oldmain,
 
 void BLO_blendfiledata_free(BlendFileData *bfd);
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name BLO Blend File Handle API
+ * \{ */
+
 BlendHandle *BLO_blendhandle_from_file(const char *filepath, struct ReportList *reports);
 BlendHandle *BLO_blendhandle_from_memory(const void *mem, int memsize);
 
@@ -119,7 +131,7 @@ struct LinkNode *BLO_blendhandle_get_linkable_groups(BlendHandle *bh);
 
 void BLO_blendhandle_close(BlendHandle *bh);
 
-/***/
+/** \} */
 
 #define BLO_GROUP_MAX 32
 #define BLO_EMBEDDED_STARTUP_BLEND "<startup.blend>"
diff --git a/source/blender/blenloader/BLO_writefile.h b/source/blender/blenloader/BLO_writefile.h
index 32cb6633c12..f9eada96308 100644
--- a/source/blender/blenloader/BLO_writefile.h
+++ b/source/blender/blenloader/BLO_writefile.h
@@ -30,6 +30,12 @@ struct Main;
 struct MemFile;
 struct ReportList;
 
+/* -------------------------------------------------------------------- */
+/** \name BLO Write File API
+ *
+ * \see #BLO_read_from_file for file reading.
+ * \{ */
+
 /**
  * Adjust paths when saving (kept unless #G_FILE_SAVE_COPY is set).
  */
@@ -66,4 +72,6 @@ extern bool BLO_write_file_mem(struct Main *mainvar,
                                struct MemFile *current,
                                int write_flags);
 
+/** \} */
+
 #endif