diff --git a/doc/Doxyfile.cmake b/doc/Doxyfile.cmake index c34c6e4..f288f56 100644 --- a/doc/Doxyfile.cmake +++ b/doc/Doxyfile.cmake @@ -674,8 +674,7 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = \ - @CMAKE_CURRENT_SOURCE_DIR@/../src/gmio_support/support_global.h \ +EXCLUDE = # 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 diff --git a/src/gmio_core/buffer.h b/src/gmio_core/buffer.h index c9045bc..3f94b77 100644 --- a/src/gmio_core/buffer.h +++ b/src/gmio_core/buffer.h @@ -15,6 +15,9 @@ /*! \file buffer.h * Declaration of gmio_buffer and utility functions + * + * \addtogroup gmio_core + * @{ */ #ifndef GMIO_BUFFER_H @@ -90,3 +93,4 @@ GMIO_LIB_EXPORT gmio_buffer_t gmio_buffer_default(); GMIO_C_LINKAGE_END #endif /* GMIO_BUFFER_H */ +/*! @} */ diff --git a/src/gmio_core/endian.h b/src/gmio_core/endian.h index 76105d4..4c45c46 100644 --- a/src/gmio_core/endian.h +++ b/src/gmio_core/endian.h @@ -15,6 +15,9 @@ /*! \file endian.h * Architecture endianness + * + * \addtogroup gmio_core + * @{ */ #ifndef GMIO_ENDIAN_H @@ -59,3 +62,4 @@ GMIO_LIB_EXPORT gmio_endianness_t gmio_host_endianness(); GMIO_C_LINKAGE_END #endif /* GMIO_ENDIAN_H */ +/*! @} */ diff --git a/src/gmio_core/error.h b/src/gmio_core/error.h index 1e4393b..5a45043 100644 --- a/src/gmio_core/error.h +++ b/src/gmio_core/error.h @@ -15,6 +15,9 @@ /*! \file error.h * List of common errors, reported by I/O functions + * + * \addtogroup gmio_core + * @{ */ #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; } #endif /* GMIO_ERROR_H */ +/*! @} */ diff --git a/src/gmio_core/global.h b/src/gmio_core/global.h index 74c3348..7bbaac9 100644 --- a/src/gmio_core/global.h +++ b/src/gmio_core/global.h @@ -15,6 +15,12 @@ /*! \file global.h * 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 @@ -161,3 +167,4 @@ typedef double gmio_float64_t; #endif /* __cplusplus */ #endif /* GMIO_GLOBAL_H */ +/*! @} */ diff --git a/src/gmio_core/stream.h b/src/gmio_core/stream.h index 7bf14e2..6454596 100644 --- a/src/gmio_core/stream.h +++ b/src/gmio_core/stream.h @@ -15,6 +15,9 @@ /*! \file stream.h * Declaration of gmio_stream and utility functions + * + * \addtogroup gmio_core + * @{ */ #ifndef GMIO_STREAM_H @@ -115,3 +118,4 @@ GMIO_LIB_EXPORT gmio_stream_t gmio_stream_stdio(FILE* file); GMIO_C_LINKAGE_END #endif /* GMIO_STREAM_H */ +/*! @} */ diff --git a/src/gmio_core/task_iface.h b/src/gmio_core/task_iface.h index 0a6b767..8be269e 100644 --- a/src/gmio_core/task_iface.h +++ b/src/gmio_core/task_iface.h @@ -15,6 +15,9 @@ /*! \file task_iface.h * Declaration of gmio_task_iface + * + * \addtogroup gmio_core + * @{ */ #ifndef GMIO_TASK_IFACE_H @@ -50,3 +53,4 @@ struct gmio_task_iface typedef struct gmio_task_iface gmio_task_iface_t; #endif /* GMIO_TASK_IFACE_H */ +/*! @} */ diff --git a/src/gmio_core/text_format.h b/src/gmio_core/text_format.h index ee6dd18..ac40aa7 100644 --- a/src/gmio_core/text_format.h +++ b/src/gmio_core/text_format.h @@ -15,6 +15,9 @@ /*! \file text_format.h * Formats for textual representation + * + * \addtogroup gmio_core + * @{ */ #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; #endif /* GMIO_TEXT_FORMAT_H */ +/*! @} */ diff --git a/src/gmio_core/transfer.h b/src/gmio_core/transfer.h index 23b59fa..2e1d9f0 100644 --- a/src/gmio_core/transfer.h +++ b/src/gmio_core/transfer.h @@ -15,6 +15,9 @@ /*! \file transfer.h * Declaration of gmio_transfer + * + * \addtogroup gmio_core + * @{ */ #ifndef GMIO_TRANSFER_H @@ -41,3 +44,4 @@ struct gmio_transfer typedef struct gmio_transfer gmio_transfer_t; #endif /* GMIO_TRANSFER_H */ +/*! @} */ diff --git a/src/gmio_stl/stl_error.h b/src/gmio_stl/stl_error.h index e9bce89..826b5f2 100644 --- a/src/gmio_stl/stl_error.h +++ b/src/gmio_stl/stl_error.h @@ -15,6 +15,9 @@ /*! \file stl_error.h * List of errors specific to STL I/O functions + * + * \addtogroup gmio_stl + * @{ */ #ifndef GMIO_STL_ERROR_H @@ -58,3 +61,4 @@ enum gmio_stl_error typedef enum gmio_stl_error gmio_stl_error_t; #endif /* GMIO_STL_ERROR_H */ +/*! @} */ diff --git a/src/gmio_stl/stl_format.h b/src/gmio_stl/stl_format.h index 7911d01..4e758f1 100644 --- a/src/gmio_stl/stl_format.h +++ b/src/gmio_stl/stl_format.h @@ -15,6 +15,9 @@ /*! \file stl_format.h * Detection of STL format from input stream + * + * \addtogroup gmio_stl + * @{ */ #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 #endif /* GMIO_STL_FORMAT_H */ +/*! @} */ diff --git a/src/gmio_stl/stl_global.h b/src/gmio_stl/stl_global.h index e3f634c..1e4958d 100644 --- a/src/gmio_stl/stl_global.h +++ b/src/gmio_stl/stl_global.h @@ -15,6 +15,12 @@ /*! \file stl_global.h * 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 @@ -35,3 +41,4 @@ #endif /* GMIO_LIBSTL_DLL */ #endif /* GMIO_STL_GLOBAL_H */ +/*! @} */ diff --git a/src/gmio_stl/stl_io.h b/src/gmio_stl/stl_io.h index 8ee34de..6d0bea4 100644 --- a/src/gmio_stl/stl_io.h +++ b/src/gmio_stl/stl_io.h @@ -15,6 +15,9 @@ /*! \file stl_io.h * STL read/write functions + * + * \addtogroup gmio_stl + * @{ */ #ifndef GMIO_STL_IO_H @@ -185,3 +188,4 @@ int gmio_stlb_write_header( GMIO_C_LINKAGE_END #endif /* GMIO_STL_IO_H */ +/*! @} */ diff --git a/src/gmio_stl/stl_io_options.h b/src/gmio_stl/stl_io_options.h index 370a535..6429e67 100644 --- a/src/gmio_stl/stl_io_options.h +++ b/src/gmio_stl/stl_io_options.h @@ -15,6 +15,9 @@ /*! \file stl_io_options.h * Options for STL read/write functions + * + * \addtogroup gmio_stl + * @{ */ #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; #endif /* GMIO_STL_IO_OPTIONS_H */ +/*! @} */ diff --git a/src/gmio_stl/stl_mesh.h b/src/gmio_stl/stl_mesh.h index cb27c32..019f3dc 100644 --- a/src/gmio_stl/stl_mesh.h +++ b/src/gmio_stl/stl_mesh.h @@ -15,6 +15,9 @@ /*! \file stl_mesh.h * Declaration of gmio_stl_mesh + * + * \addtogroup gmio_stl + * @{ */ #ifndef GMIO_STL_MESH_H @@ -42,3 +45,4 @@ struct gmio_stl_mesh typedef struct gmio_stl_mesh gmio_stl_mesh_t; #endif /* GMIO_STL_MESH_H */ +/*! @} */ diff --git a/src/gmio_stl/stl_mesh_creator.h b/src/gmio_stl/stl_mesh_creator.h index 64473bb..55570cc 100644 --- a/src/gmio_stl/stl_mesh_creator.h +++ b/src/gmio_stl/stl_mesh_creator.h @@ -15,6 +15,9 @@ /*! \file stl_mesh_creator.h * Declaration of gmio_stl_mesh_creator + * + * \addtogroup gmio_stl + * @{ */ #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; #endif /* GMIO_STL_MESH_CREATOR_H */ +/*! @} */ diff --git a/src/gmio_stl/stl_triangle.h b/src/gmio_stl/stl_triangle.h index 15268a5..3008e9f 100644 --- a/src/gmio_stl/stl_triangle.h +++ b/src/gmio_stl/stl_triangle.h @@ -15,6 +15,9 @@ /*! \file stl_triangle.h * Declaration of gmio_stl_coords and gmio_stl_triangle + * + * \addtogroup gmio_stl + * @{ */ #ifndef GMIO_STL_TRIANGLE_H @@ -59,3 +62,4 @@ enum { }; #endif /* GMIO_STL_TRIANGLE_H */ +/*! @} */ diff --git a/src/gmio_stl/stlb_header.h b/src/gmio_stl/stlb_header.h index db3aef7..9869b69 100644 --- a/src/gmio_stl/stlb_header.h +++ b/src/gmio_stl/stlb_header.h @@ -15,6 +15,9 @@ /*! \file stlb_header.h * Declaration of gmio_stlb_header + * + * \addtogroup gmio_stl + * @{ */ #ifndef GMIO_STLB_HEADER_H @@ -33,3 +36,4 @@ struct gmio_stlb_header typedef struct gmio_stlb_header gmio_stlb_header_t; #endif /* GMIO_STLB_HEADER_H */ +/*! @} */ diff --git a/src/gmio_support/stl_occ.h b/src/gmio_support/stl_occ.h index 83a8344..6016e62 100644 --- a/src/gmio_support/stl_occ.h +++ b/src/gmio_support/stl_occ.h @@ -15,6 +15,9 @@ /*! \file stl_occ.h * Support of OpenCascade's StlMesh_Mesh + * +* \addtogroup gmio_support + * @{ */ #ifndef __cplusplus @@ -69,3 +72,4 @@ GMIO_LIBSUPPORT_EXPORT gmio_stl_mesh_creator_t gmio_stl_hnd_occmesh_creator(const Handle_StlMesh_Mesh& hnd); #endif /* GMIO_SUPPORT_STL_OCC_H */ +/*! @} */ diff --git a/src/gmio_support/stream_qt.h b/src/gmio_support/stream_qt.h index aa78bb3..f649240 100644 --- a/src/gmio_support/stream_qt.h +++ b/src/gmio_support/stream_qt.h @@ -15,6 +15,9 @@ /*! \file stream_qt.h * Support of Qt's QIODevice (requires at least Qt4) + * +* \addtogroup gmio_support + * @{ */ #ifndef GMIO_SUPPORT_STREAM_QT_H @@ -39,3 +42,4 @@ gmio_stream_t gmio_stream_qiodevice( ); #endif /* GMIO_SUPPORT_STREAM_QT_H */ +/*! @} */ diff --git a/src/gmio_support/support_global.h b/src/gmio_support/support_global.h index c921e74..1485845 100644 --- a/src/gmio_support/support_global.h +++ b/src/gmio_support/support_global.h @@ -13,6 +13,16 @@ ** "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 #define GMIO_SUPPORT_GLOBAL_H @@ -29,3 +39,4 @@ #endif /* GMIO_LIBSUPPORT_DLL */ #endif /* GMIO_SUPPORT_GLOBAL_H */ +/*! @} */