Use Doxygen grouping
This commit is contained in:
parent
16fdbb799c
commit
e60938ea84
@ -674,8 +674,7 @@ RECURSIVE = YES
|
|||||||
# Note that relative paths are relative to the directory from which doxygen is
|
# Note that relative paths are relative to the directory from which doxygen is
|
||||||
# run.
|
# run.
|
||||||
|
|
||||||
EXCLUDE = \
|
EXCLUDE =
|
||||||
@CMAKE_CURRENT_SOURCE_DIR@/../src/gmio_support/support_global.h \
|
|
||||||
|
|
||||||
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
|
||||||
# directories that are symbolic links (a Unix file system feature) are excluded
|
# directories that are symbolic links (a Unix file system feature) are excluded
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file buffer.h
|
/*! \file buffer.h
|
||||||
* Declaration of gmio_buffer and utility functions
|
* Declaration of gmio_buffer and utility functions
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_core
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_BUFFER_H
|
#ifndef GMIO_BUFFER_H
|
||||||
@ -90,3 +93,4 @@ GMIO_LIB_EXPORT gmio_buffer_t gmio_buffer_default();
|
|||||||
GMIO_C_LINKAGE_END
|
GMIO_C_LINKAGE_END
|
||||||
|
|
||||||
#endif /* GMIO_BUFFER_H */
|
#endif /* GMIO_BUFFER_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file endian.h
|
/*! \file endian.h
|
||||||
* Architecture endianness
|
* Architecture endianness
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_core
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_ENDIAN_H
|
#ifndef GMIO_ENDIAN_H
|
||||||
@ -59,3 +62,4 @@ GMIO_LIB_EXPORT gmio_endianness_t gmio_host_endianness();
|
|||||||
GMIO_C_LINKAGE_END
|
GMIO_C_LINKAGE_END
|
||||||
|
|
||||||
#endif /* GMIO_ENDIAN_H */
|
#endif /* GMIO_ENDIAN_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file error.h
|
/*! \file error.h
|
||||||
* List of common errors, reported by I/O functions
|
* List of common errors, reported by I/O functions
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_core
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_ERROR_H
|
#ifndef GMIO_ERROR_H
|
||||||
@ -65,3 +68,4 @@ GMIO_INLINE gmio_bool_t gmio_error(int code)
|
|||||||
{ return code != GMIO_ERROR_OK ? GMIO_TRUE : GMIO_FALSE; }
|
{ return code != GMIO_ERROR_OK ? GMIO_TRUE : GMIO_FALSE; }
|
||||||
|
|
||||||
#endif /* GMIO_ERROR_H */
|
#endif /* GMIO_ERROR_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,12 @@
|
|||||||
|
|
||||||
/*! \file global.h
|
/*! \file global.h
|
||||||
* Fundamental global declarations, included by almost all other header files
|
* Fundamental global declarations, included by almost all other header files
|
||||||
|
*
|
||||||
|
* \defgroup gmio_core gmioCore
|
||||||
|
* All other gmio modules rely on this module
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_core
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_GLOBAL_H
|
#ifndef GMIO_GLOBAL_H
|
||||||
@ -161,3 +167,4 @@ typedef double gmio_float64_t;
|
|||||||
#endif /* __cplusplus */
|
#endif /* __cplusplus */
|
||||||
|
|
||||||
#endif /* GMIO_GLOBAL_H */
|
#endif /* GMIO_GLOBAL_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file stream.h
|
/*! \file stream.h
|
||||||
* Declaration of gmio_stream and utility functions
|
* Declaration of gmio_stream and utility functions
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_core
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_STREAM_H
|
#ifndef GMIO_STREAM_H
|
||||||
@ -115,3 +118,4 @@ GMIO_LIB_EXPORT gmio_stream_t gmio_stream_stdio(FILE* file);
|
|||||||
GMIO_C_LINKAGE_END
|
GMIO_C_LINKAGE_END
|
||||||
|
|
||||||
#endif /* GMIO_STREAM_H */
|
#endif /* GMIO_STREAM_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file task_iface.h
|
/*! \file task_iface.h
|
||||||
* Declaration of gmio_task_iface
|
* Declaration of gmio_task_iface
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_core
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_TASK_IFACE_H
|
#ifndef GMIO_TASK_IFACE_H
|
||||||
@ -50,3 +53,4 @@ struct gmio_task_iface
|
|||||||
typedef struct gmio_task_iface gmio_task_iface_t;
|
typedef struct gmio_task_iface gmio_task_iface_t;
|
||||||
|
|
||||||
#endif /* GMIO_TASK_IFACE_H */
|
#endif /* GMIO_TASK_IFACE_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file text_format.h
|
/*! \file text_format.h
|
||||||
* Formats for textual representation
|
* Formats for textual representation
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_core
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_TEXT_FORMAT_H
|
#ifndef GMIO_TEXT_FORMAT_H
|
||||||
@ -41,3 +44,4 @@ enum gmio_float_text_format
|
|||||||
typedef enum gmio_float_text_format gmio_float_text_format_t;
|
typedef enum gmio_float_text_format gmio_float_text_format_t;
|
||||||
|
|
||||||
#endif /* GMIO_TEXT_FORMAT_H */
|
#endif /* GMIO_TEXT_FORMAT_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file transfer.h
|
/*! \file transfer.h
|
||||||
* Declaration of gmio_transfer
|
* Declaration of gmio_transfer
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_core
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_TRANSFER_H
|
#ifndef GMIO_TRANSFER_H
|
||||||
@ -41,3 +44,4 @@ struct gmio_transfer
|
|||||||
typedef struct gmio_transfer gmio_transfer_t;
|
typedef struct gmio_transfer gmio_transfer_t;
|
||||||
|
|
||||||
#endif /* GMIO_TRANSFER_H */
|
#endif /* GMIO_TRANSFER_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file stl_error.h
|
/*! \file stl_error.h
|
||||||
* List of errors specific to STL I/O functions
|
* List of errors specific to STL I/O functions
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_stl
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_STL_ERROR_H
|
#ifndef GMIO_STL_ERROR_H
|
||||||
@ -58,3 +61,4 @@ enum gmio_stl_error
|
|||||||
typedef enum gmio_stl_error gmio_stl_error_t;
|
typedef enum gmio_stl_error gmio_stl_error_t;
|
||||||
|
|
||||||
#endif /* GMIO_STL_ERROR_H */
|
#endif /* GMIO_STL_ERROR_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file stl_format.h
|
/*! \file stl_format.h
|
||||||
* Detection of STL format from input stream
|
* Detection of STL format from input stream
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_stl
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_STL_FORMAT_H
|
#ifndef GMIO_STL_FORMAT_H
|
||||||
@ -60,3 +63,4 @@ gmio_stl_format_t gmio_stl_get_format_file(const char* filepath);
|
|||||||
GMIO_C_LINKAGE_END
|
GMIO_C_LINKAGE_END
|
||||||
|
|
||||||
#endif /* GMIO_STL_FORMAT_H */
|
#endif /* GMIO_STL_FORMAT_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,12 @@
|
|||||||
|
|
||||||
/*! \file stl_global.h
|
/*! \file stl_global.h
|
||||||
* Global declarations for the STL module
|
* Global declarations for the STL module
|
||||||
|
*
|
||||||
|
* \defgroup gmio_stl gmioSTL
|
||||||
|
* Provides API to handle input/output operations with the STL file format
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_stl
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_STL_GLOBAL_H
|
#ifndef GMIO_STL_GLOBAL_H
|
||||||
@ -35,3 +41,4 @@
|
|||||||
#endif /* GMIO_LIBSTL_DLL */
|
#endif /* GMIO_LIBSTL_DLL */
|
||||||
|
|
||||||
#endif /* GMIO_STL_GLOBAL_H */
|
#endif /* GMIO_STL_GLOBAL_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file stl_io.h
|
/*! \file stl_io.h
|
||||||
* STL read/write functions
|
* STL read/write functions
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_stl
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_STL_IO_H
|
#ifndef GMIO_STL_IO_H
|
||||||
@ -185,3 +188,4 @@ int gmio_stlb_write_header(
|
|||||||
GMIO_C_LINKAGE_END
|
GMIO_C_LINKAGE_END
|
||||||
|
|
||||||
#endif /* GMIO_STL_IO_H */
|
#endif /* GMIO_STL_IO_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file stl_io_options.h
|
/*! \file stl_io_options.h
|
||||||
* Options for STL read/write functions
|
* Options for STL read/write functions
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_stl
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_STL_IO_OPTIONS_H
|
#ifndef GMIO_STL_IO_OPTIONS_H
|
||||||
@ -80,3 +83,4 @@ struct gmio_stl_write_options
|
|||||||
typedef struct gmio_stl_write_options gmio_stl_write_options_t;
|
typedef struct gmio_stl_write_options gmio_stl_write_options_t;
|
||||||
|
|
||||||
#endif /* GMIO_STL_IO_OPTIONS_H */
|
#endif /* GMIO_STL_IO_OPTIONS_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file stl_mesh.h
|
/*! \file stl_mesh.h
|
||||||
* Declaration of gmio_stl_mesh
|
* Declaration of gmio_stl_mesh
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_stl
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_STL_MESH_H
|
#ifndef GMIO_STL_MESH_H
|
||||||
@ -42,3 +45,4 @@ struct gmio_stl_mesh
|
|||||||
typedef struct gmio_stl_mesh gmio_stl_mesh_t;
|
typedef struct gmio_stl_mesh gmio_stl_mesh_t;
|
||||||
|
|
||||||
#endif /* GMIO_STL_MESH_H */
|
#endif /* GMIO_STL_MESH_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file stl_mesh_creator.h
|
/*! \file stl_mesh_creator.h
|
||||||
* Declaration of gmio_stl_mesh_creator
|
* Declaration of gmio_stl_mesh_creator
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_stl
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_STL_MESH_CREATOR_H
|
#ifndef GMIO_STL_MESH_CREATOR_H
|
||||||
@ -78,3 +81,4 @@ struct gmio_stl_mesh_creator
|
|||||||
typedef struct gmio_stl_mesh_creator gmio_stl_mesh_creator_t;
|
typedef struct gmio_stl_mesh_creator gmio_stl_mesh_creator_t;
|
||||||
|
|
||||||
#endif /* GMIO_STL_MESH_CREATOR_H */
|
#endif /* GMIO_STL_MESH_CREATOR_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file stl_triangle.h
|
/*! \file stl_triangle.h
|
||||||
* Declaration of gmio_stl_coords and gmio_stl_triangle
|
* Declaration of gmio_stl_coords and gmio_stl_triangle
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_stl
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_STL_TRIANGLE_H
|
#ifndef GMIO_STL_TRIANGLE_H
|
||||||
@ -59,3 +62,4 @@ enum {
|
|||||||
};
|
};
|
||||||
|
|
||||||
#endif /* GMIO_STL_TRIANGLE_H */
|
#endif /* GMIO_STL_TRIANGLE_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file stlb_header.h
|
/*! \file stlb_header.h
|
||||||
* Declaration of gmio_stlb_header
|
* Declaration of gmio_stlb_header
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_stl
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_STLB_HEADER_H
|
#ifndef GMIO_STLB_HEADER_H
|
||||||
@ -33,3 +36,4 @@ struct gmio_stlb_header
|
|||||||
typedef struct gmio_stlb_header gmio_stlb_header_t;
|
typedef struct gmio_stlb_header gmio_stlb_header_t;
|
||||||
|
|
||||||
#endif /* GMIO_STLB_HEADER_H */
|
#endif /* GMIO_STLB_HEADER_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file stl_occ.h
|
/*! \file stl_occ.h
|
||||||
* Support of OpenCascade's StlMesh_Mesh
|
* Support of OpenCascade's StlMesh_Mesh
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_support
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef __cplusplus
|
#ifndef __cplusplus
|
||||||
@ -69,3 +72,4 @@ GMIO_LIBSUPPORT_EXPORT
|
|||||||
gmio_stl_mesh_creator_t gmio_stl_hnd_occmesh_creator(const Handle_StlMesh_Mesh& hnd);
|
gmio_stl_mesh_creator_t gmio_stl_hnd_occmesh_creator(const Handle_StlMesh_Mesh& hnd);
|
||||||
|
|
||||||
#endif /* GMIO_SUPPORT_STL_OCC_H */
|
#endif /* GMIO_SUPPORT_STL_OCC_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -15,6 +15,9 @@
|
|||||||
|
|
||||||
/*! \file stream_qt.h
|
/*! \file stream_qt.h
|
||||||
* Support of Qt's QIODevice (requires at least Qt4)
|
* Support of Qt's QIODevice (requires at least Qt4)
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_support
|
||||||
|
* @{
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_SUPPORT_STREAM_QT_H
|
#ifndef GMIO_SUPPORT_STREAM_QT_H
|
||||||
@ -39,3 +42,4 @@ gmio_stream_t gmio_stream_qiodevice(
|
|||||||
);
|
);
|
||||||
|
|
||||||
#endif /* GMIO_SUPPORT_STREAM_QT_H */
|
#endif /* GMIO_SUPPORT_STREAM_QT_H */
|
||||||
|
/*! @} */
|
||||||
|
@ -13,6 +13,16 @@
|
|||||||
** "http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html".
|
** "http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html".
|
||||||
****************************************************************************/
|
****************************************************************************/
|
||||||
|
|
||||||
|
/*! \file support_global.h
|
||||||
|
* Global declarations for the support module
|
||||||
|
*
|
||||||
|
* \defgroup gmio_support gmioSupport
|
||||||
|
* Provides facilities to integrate seamlessly with other 3rd-party libraries
|
||||||
|
*
|
||||||
|
* \addtogroup gmio_support
|
||||||
|
* @{
|
||||||
|
*/
|
||||||
|
|
||||||
#ifndef GMIO_SUPPORT_GLOBAL_H
|
#ifndef GMIO_SUPPORT_GLOBAL_H
|
||||||
#define GMIO_SUPPORT_GLOBAL_H
|
#define GMIO_SUPPORT_GLOBAL_H
|
||||||
|
|
||||||
@ -29,3 +39,4 @@
|
|||||||
#endif /* GMIO_LIBSUPPORT_DLL */
|
#endif /* GMIO_LIBSUPPORT_DLL */
|
||||||
|
|
||||||
#endif /* GMIO_SUPPORT_GLOBAL_H */
|
#endif /* GMIO_SUPPORT_GLOBAL_H */
|
||||||
|
/*! @} */
|
||||||
|
Loading…
Reference in New Issue
Block a user