caiyu/gmio
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: fix doxygen warnings

Browse Source
This commit is contained in:
Hugues Delorme 2015-04-02 10:30:09 +02:00
parent 8ed353ac0e
commit 9649f47188
2 changed files with 3 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
doc/Doxyfile
View File

@ -321,22 +321,6 @@ INLINE_SIMPLE_STRUCTS = YES
TYPEDEF_HIDES_STRUCT = NO TYPEDEF_HIDES_STRUCT = NO
# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to
# determine which symbols to keep in memory and which to flush to disk.
# When the cache is full, less often used symbols will be written to disk.
# For small to medium size projects (<1000 input files) the default value is
# probably good enough. For larger projects a too small cache size can cause
# doxygen to be busy swapping symbols to and from disk most of the time
# causing a significant performance penalty.
# If the system has enough physical memory increasing the cache will improve the
# performance by keeping more symbols in memory. Note that the value works on
# a logarithmic scale so increasing the size by one will roughly double the
# memory usage. The cache size is given by this formula:
# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0,
# corresponding to a cache size of 2^16 = 65536 symbols.
SYMBOL_CACHE_SIZE = 0
# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be # Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be
# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given # set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given
# their name and scope. Since this can be an expensive process and often the # their name and scope. Since this can be an expensive process and often the
@ -1393,18 +1377,6 @@ GENERATE_XML = NO
XML_OUTPUT = xml XML_OUTPUT = xml
# The XML_SCHEMA tag can be used to specify an XML schema,
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_SCHEMA =
# The XML_DTD tag can be used to specify an XML DTD,
# which can be used by a validating XML parser to check the
# syntax of the XML files.
XML_DTD =
# If the XML_PROGRAMLISTING tag is set to YES Doxygen will # If the XML_PROGRAMLISTING tag is set to YES Doxygen will
# dump the program listings (including syntax highlighting # dump the program listings (including syntax highlighting
# and cross-referencing information) to the XML output. Note that # and cross-referencing information) to the XML output. Note that

8
src/gmio_stl/stl_io.h
View File

@ -62,10 +62,8 @@ int gmio_stl_read(
/*! Reads geometry from STL ascii stream /*! Reads geometry from STL ascii stream
* *
* \param creator Defines the callbacks for the mesh creation
* \param trsf Defines needed objects for the read operation * \param trsf Defines needed objects for the read operation
* \param options Options for the operation, shoul be set to NULL (just here * \param creator Defines the callbacks for the mesh creation
* for future use)
* *
* Stream size is passed to gmio_transfer::handle_progress_func() as the * Stream size is passed to gmio_transfer::handle_progress_func() as the
* \p max_value argument. * \p max_value argument.
@ -124,9 +122,9 @@ int gmio_stla_write(
/*! Reads geometry from STL binary stream /*! Reads geometry from STL binary stream
* *
* \param mesh Defines the callbacks for the mesh creation
* \param trsf Defines needed objects for the read operation * \param trsf Defines needed objects for the read operation
* \param options Byte order of the input STL binary data * \param creator Defines the callbacks for the mesh creation
* \param byte_order Byte order of the input STL binary data
* *
* \return Error code (see error.h and stl_error.h) * \return Error code (see error.h and stl_error.h)
* \retval GMIO_ERROR_INVALID_BUFFER_SIZE * \retval GMIO_ERROR_INVALID_BUFFER_SIZE