AuroraMiddleware/flac
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

include: Escape number signs to suppress warnings

Browse Source 
Doxygen sees '#' as a cross-reference, which this is not in this case. This will silence the following warning that pops up frequently when building with docs:

warning: explicit link request to 'defines' could not be resolved

The code shorthand tag was removed in include\FLAC\all.h to remain synonymous with other mentions of #define.
This commit is contained in:
NotTsunami 2019-11-18 16:51:04 -05:00 committed by Erik de Castro Lopo
parent 3a151a207b
commit 3bb5d8cd76
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
include/FLAC++/export.h
View File

@ -36,7 +36,7 @@
/** \file include/FLAC++/export.h /** \file include/FLAC++/export.h
* *
* \brief * \brief
* This module contains #defines and symbols for exporting function * This module contains \#defines and symbols for exporting function
* calls, and providing version information and compiled-in features. * calls, and providing version information and compiled-in features.
* *
* See the \link flacpp_export export \endlink module. * See the \link flacpp_export export \endlink module.
@ -46,7 +46,7 @@
* \ingroup flacpp * \ingroup flacpp
* *
* \brief * \brief
* This module contains #defines and symbols for exporting function * This module contains \#defines and symbols for exporting function
* calls, and providing version information and compiled-in features. * calls, and providing version information and compiled-in features.
* *
* If you are compiling with MSVC and will link to the static library * If you are compiling with MSVC and will link to the static library
@ -74,7 +74,7 @@
#endif #endif
/* These #defines will mirror the libtool-based library version number, see /* These \#defines will mirror the libtool-based library version number, see
* http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning * http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning
*/ */
#define FLACPP_API_VERSION_CURRENT 9 #define FLACPP_API_VERSION_CURRENT 9

6
include/FLAC/all.h
View File

@ -147,7 +147,7 @@
* library. * library.
* *
* Also, there are several places in the libFLAC code with comments marked * Also, there are several places in the libFLAC code with comments marked
* with "OPT:" where a #define can be changed to enable code that might be * with "OPT:" where a \#define can be changed to enable code that might be
* faster on a specific platform. Experimenting with these can yield faster * faster on a specific platform. Experimenting with these can yield faster
* binaries. * binaries.
*/ */
@ -159,9 +159,9 @@
* the libraries to newer versions of FLAC. * the libraries to newer versions of FLAC.
* *
* One simple facility for making porting easier that has been added * One simple facility for making porting easier that has been added
* in FLAC 1.1.3 is a set of \c #defines in \c export.h of each * in FLAC 1.1.3 is a set of \#defines in \c export.h of each
* library's includes (e.g. \c include/FLAC/export.h). The * library's includes (e.g. \c include/FLAC/export.h). The
* \c #defines mirror the libraries' * \#defines mirror the libraries'
* <A HREF="http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning">libtool version numbers</A>, * <A HREF="http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning">libtool version numbers</A>,
* e.g. in libFLAC there are \c FLAC_API_VERSION_CURRENT, * e.g. in libFLAC there are \c FLAC_API_VERSION_CURRENT,
* \c FLAC_API_VERSION_REVISION, and \c FLAC_API_VERSION_AGE. * \c FLAC_API_VERSION_REVISION, and \c FLAC_API_VERSION_AGE.

6
include/FLAC/export.h
View File

@ -36,7 +36,7 @@
/** \file include/FLAC/export.h /** \file include/FLAC/export.h
* *
* \brief * \brief
* This module contains #defines and symbols for exporting function * This module contains \#defines and symbols for exporting function
* calls, and providing version information and compiled-in features. * calls, and providing version information and compiled-in features.
* *
* See the \link flac_export export \endlink module. * See the \link flac_export export \endlink module.
@ -46,7 +46,7 @@
* \ingroup flac * \ingroup flac
* *
* \brief * \brief
* This module contains #defines and symbols for exporting function * This module contains \#defines and symbols for exporting function
* calls, and providing version information and compiled-in features. * calls, and providing version information and compiled-in features.
* *
* If you are compiling with MSVC and will link to the static library * If you are compiling with MSVC and will link to the static library
@ -74,7 +74,7 @@
#endif #endif
/** These #defines will mirror the libtool-based library version number, see /** These \#defines will mirror the libtool-based library version number, see
* http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning * http://www.gnu.org/software/libtool/manual/libtool.html#Libtool-versioning
*/ */
#define FLAC_API_VERSION_CURRENT 11 #define FLAC_API_VERSION_CURRENT 11