IO group comments reworked in doxygen format (#149)

Author: ABSitf

source/MRMesh/MRBase64.h

@@ -7,10 +7,20 @@
 namespace MR
 {
 
-// encodes binary data into textual Base64 format
+
+/// \defgroup IOGroup
+/// \{
+
+/// \defgroup Base64Group Base64
+/// \{
+
+/// encodes binary data into textual Base64 format
 MRMESH_API std::string encode64( const std::uint8_t * data, size_t size );
 
-// decodes Base64 format into binary data
+/// decodes Base64 format into binary data
 MRMESH_API std::vector<std::uint8_t> decode64( const std::string &val );
 
-} //namespace MR
+/// \}
+/// \}
+
+} // namespace MR

source/MRMesh/MRDistanceMapLoad.h

@@ -10,6 +10,10 @@ namespace MR
 namespace DistanceMapLoad
 {
 
+/// \defgroup DistanceMapLoadGroup DistanceMap Load
+/// \ingroup IOGroup
+/// \{
+
 MRMESH_API extern const IOFilters Filters;
 
 /**
@@ -20,6 +24,8 @@ MRMESH_API extern const IOFilters Filters;
  */
 MRMESH_API tl::expected<DistanceMap, std::string> loadRaw( const std::filesystem::path& path );
 
+/// \}
+
 } // namespace DistanceMapLoad
 
 } // namespace MR

source/MRMesh/MRDistanceMapSave.h

@@ -10,6 +10,10 @@ namespace MR
 namespace DistanceMapSave
 {
 
+/// \defgroup DistanceMapSaveGroup DistanceMap Save
+/// \ingroup IOGroup
+/// \{
+
 MRMESH_API extern const IOFilters Filters;
 
 /**
@@ -20,6 +24,8 @@ MRMESH_API extern const IOFilters Filters;
  */
 MRMESH_API tl::expected<void, std::string> saveRAW( const std::filesystem::path& path, const DistanceMap& dmapObject );
 
+/// \}
+
 } // namespace DistanceMapSave
 
 } // namespace MR

source/MRMesh/MRIOFilters.h

@@ -5,6 +5,11 @@
 
 namespace MR
 {
+
+/// \defgroup IOFiltersGroup IO Filters
+/// \ingroup IOGroup
+/// \{
+
 struct IOFilter
 {
     IOFilter() = default;
@@ -30,4 +35,6 @@ inline IOFilters operator | ( const IOFilters& a, const IOFilters& b )
     return copy;
 }
 
+/// \}
+
 }

source/MRMesh/MRIOFormatsRegistry.h

@@ -9,6 +9,11 @@ namespace MR
 
 namespace MeshLoad
 {
+
+/// \defgroup IOFormatsRegistryGroup IO Formats Registry
+/// \ingroup IOGroup
+/// \{
+
 using MeshLoader = tl::expected<MR::Mesh, std::string>( * )( const std::filesystem::path&, std::vector<Color>* );
 using MeshStreamLoader = tl::expected<MR::Mesh, std::string>( * )( std::istream&, std::vector<Color>* );
 
@@ -19,17 +24,19 @@ struct NamedMeshLoader
     MeshStreamLoader streamLoader{ nullptr };
 };
 
-// Finds expected loader from registry
+/// Finds expected loader from registry
 MRMESH_API MeshLoader getMeshLoader( IOFilter filter );
-// Finds expected loader from registry
+/// Finds expected loader from registry
 MRMESH_API MeshStreamLoader getMeshStreamLoader( IOFilter filter );
-// Gets all registered filters
+/// Gets all registered filters
 MRMESH_API IOFilters getFilters();
 
-// Register filter with loader function
-// loader function signature: tl::expected<Mesh, std::string> fromFormat( const std::filesystem::path& path, std::vector<Color>* colors );
-// example:
-// ADD_MESH_LOADER( IOFilter("Name of filter (.ext)","*.ext"), fromFormat)
+/** 
+ * \brief Register filter with loader function
+ * \details loader function signature: tl::expected<Mesh, std::string> fromFormat( const std::filesystem::path& path, std::vector<Color>* colors );
+ * example:
+ * ADD_MESH_LOADER( IOFilter("Name of filter (.ext)","*.ext"), fromFormat)
+ */
 #define MR_ADD_MESH_LOADER( filter, loader ) \
 MR::MeshLoad::MeshLoaderAdder __meshLoaderAdder_##loader(MR::MeshLoad::NamedMeshLoader{filter,static_cast<MR::MeshLoad::MeshLoader>(loader),static_cast<MR::MeshLoad::MeshStreamLoader>(loader)});\
 
@@ -39,6 +46,8 @@ class MeshLoaderAdder
     MRMESH_API MeshLoaderAdder( const NamedMeshLoader& loader );
 };
 
+/// \}
+
 }
 
 }

source/MRMesh/MRImageLoad.h

@@ -13,14 +13,21 @@ struct Image;
 namespace ImageLoad
 {
 
+/// \defgroup ImageLoadGroup Image Load
+/// \ingroup IOGroup
+/// \{
+
 MRMESH_API extern const IOFilters Filters;
 
-// loads from .png format
+/// loads from .png format
 MRMESH_API tl::expected<Image, std::string> fromPng( const std::filesystem::path& path );
 
-// detects the format from file extension and loads image from it
+/// detects the format from file extension and loads image from it
 MRMESH_API tl::expected<Image, std::string> fromAnySupportedFormat( const std::filesystem::path& path );
 
+/// \}
+
 }
+
 }
 #endif

source/MRMesh/MRImageSave.h

@@ -12,24 +12,31 @@ struct Image;
 namespace ImageSave
 {
 
+/// \defgroup ImageSaveGroup Image Save
+/// \ingroup IOGroup
+/// \{
+
 MRMESH_API extern const IOFilters Filters;
 
-// saves in .bmp format
+/// saves in .bmp format
 MRMESH_API tl::expected<void, std::string> toBmp( const Image& image, const std::filesystem::path& path );
 
 #ifndef __EMSCRIPTEN__
-// saves in .png format
+/// saves in .png format
 MRMESH_API tl::expected<void, std::string> toPng( const Image& image, const std::filesystem::path& path );
 
-// saves in .png format
+/// saves in .png format
 MRMESH_API tl::expected<void, std::string> toPng( const Image& image, std::ostream& os );
 
-// saves in .jpg format
+/// saves in .jpg format
 MRMESH_API tl::expected<void, std::string> toJpeg( const Image& image, const std::filesystem::path& path );
 #endif
 
-// detects the format from file extension and save image to it  
+/// detects the format from file extension and save image to it  
 MRMESH_API tl::expected<void, std::string> toAnySupportedFormat( const Image& image, const std::filesystem::path& path );
 
+/// \}
+
 }
+
 }

source/MRMesh/MRLinesLoad.h

@@ -13,17 +13,23 @@ namespace MR
 namespace LinesLoad
 {
 
+/// \defgroup LinesLoad Lines Load
+/// \ingroup IOGroup
+/// \{
+
 MRMESH_API extern const IOFilters Filters;
 
-// loads from .mrlines file
+/// loads from .mrlines file
 MRMESH_API tl::expected<Polyline3, std::string> fromMrLines( const std::filesystem::path& file );
 MRMESH_API tl::expected<Polyline3, std::string> fromMrLines( std::istream& in );
 
-// detects the format from file extension and loads polyline from it
+/// detects the format from file extension and loads polyline from it
 MRMESH_API tl::expected<Polyline3, std::string> fromAnySupportedFormat( const std::filesystem::path& file );
-// extension in `*.ext` format
+/// extension in `*.ext` format
 MRMESH_API tl::expected<Polyline3, std::string> fromAnySupportedFormat( std::istream& in, const std::string& extension );
 
-} //namespace LinesLoad
+/// \}
+
+} // namespace LinesLoad
 
-} //namespace MR
+} // namespace MR

source/MRMesh/MRLinesSave.h

@@ -13,17 +13,21 @@ namespace MR
 namespace LinesSave
 {
 
+/// \defgroup LinesSaveGroup Lines Save
+/// \ingroup IOGroup
+/// \{
+
 MRMESH_API extern const IOFilters Filters;
 
-// saves in .mrlines file
+/// saves in .mrlines file
 MRMESH_API tl::expected<void, std::string> toMrLines( const Polyline3& polyline, const std::filesystem::path& file );
 MRMESH_API tl::expected<void, std::string> toMrLines( const Polyline3& polyline, std::ostream& out );
 
-// detects the format from file extension and saves polyline in it
+/// detects the format from file extension and saves polyline in it
 MRMESH_API tl::expected<void, std::string> toAnySupportedFormat( const Polyline3& polyline, const std::filesystem::path& file );
-// extension in `*.ext` format
+/// extension in `*.ext` format
 MRMESH_API tl::expected<void, std::string> toAnySupportedFormat( const Polyline3& polyline, std::ostream& out, const std::string& extension );
 
-} //namespace LinesSave
+} // namespace LinesSave
 
-} //namespace MR
+} // namespace MR

source/MRMesh/MRMeshLoad.h

@@ -14,42 +14,48 @@ namespace MR
 namespace MeshLoad
 {
 
-// loads from internal file format
+/// \defgroup MeshLoadGroup Mesh Load
+/// \ingroup IOGroup
+/// \{
+
+/// loads from internal file format
 MRMESH_API tl::expected<Mesh, std::string> fromMrmesh( const std::filesystem::path& file, std::vector<Color>* colors = nullptr );
 MRMESH_API tl::expected<Mesh, std::string> fromMrmesh( std::istream& in, std::vector<Color>* colors = nullptr );
 
-// loads from .off file
+/// loads from .off file
 MRMESH_API tl::expected<Mesh, std::string> fromOff( const std::filesystem::path& file, std::vector<Color>* colors = nullptr );
 MRMESH_API tl::expected<Mesh, std::string> fromOff( std::istream& in, std::vector<Color>* colors = nullptr );
 
-// loads from .obj file
+/// loads from .obj file
 MRMESH_API tl::expected<Mesh, std::string> fromObj( const std::filesystem::path& file, std::vector<Color>* colors = nullptr );
 MRMESH_API tl::expected<Mesh, std::string> fromObj( std::istream& in, std::vector<Color>* colors = nullptr );
-// loads from any .stl
+/// loads from any .stl
 MRMESH_API tl::expected<Mesh, std::string> fromAnyStl( const std::filesystem::path& file, std::vector<Color>* colors = nullptr );
 MRMESH_API tl::expected<Mesh, std::string> fromAnyStl( std::istream& in, std::vector<Color>* colors = nullptr );
 
-// loads from binary .stl
+/// loads from binary .stl
 MRMESH_API tl::expected<Mesh, std::string> fromBinaryStl( const std::filesystem::path & file, std::vector<Color>* colors = nullptr );
 MRMESH_API tl::expected<Mesh, std::string> fromBinaryStl( std::istream & in, std::vector<Color>* colors = nullptr );
 
-// loads from ASCII .stl
+/// loads from ASCII .stl
 MRMESH_API tl::expected<Mesh, std::string> fromASCIIStl( const std::filesystem::path& file, std::vector<Color>* colors = nullptr );
 MRMESH_API tl::expected<Mesh, std::string> fromASCIIStl( std::istream& in, std::vector<Color>* colors = nullptr );
 
-// loads from .ply file
+/// loads from .ply file
 MRMESH_API tl::expected<Mesh, std::string> fromPly( const std::filesystem::path& file, std::vector<Color>* colors = nullptr );
 MRMESH_API tl::expected<Mesh, std::string> fromPly( std::istream& in, std::vector<Color>* colors = nullptr );
 
-// loads from .ctm file
+/// loads from .ctm file
 MRMESH_API tl::expected<Mesh, std::string> fromCtm( const std::filesystem::path & file, std::vector<Color>* colors = nullptr );
 MRMESH_API tl::expected<Mesh, std::string> fromCtm( std::istream & in, std::vector<Color>* colors = nullptr );
 
-// detects the format from file extension and loads mesh from it
+/// detects the format from file extension and loads mesh from it
 MRMESH_API tl::expected<Mesh, std::string> fromAnySupportedFormat( const std::filesystem::path& file, std::vector<Color>* colors = nullptr );
-// extension in `*.ext` format
+/// extension in `*.ext` format
 MRMESH_API tl::expected<Mesh, std::string> fromAnySupportedFormat( std::istream& in, const std::string& extension, std::vector<Color>* colors = nullptr );
 
-} //namespace MeshLoad
+/// \}
+
+} // namespace MeshLoad
 
-} //namespace MR
+} // namespace MR