summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNotTsunami <4589807+NotTsunami@users.noreply.github.com>2019-11-18 16:51:04 -0500
committerErik de Castro Lopo <erikd@mega-nerd.com>2019-11-19 16:14:47 +1100
commit3bb5d8cd761a2bd47a1a03366e00f5c83f88fedc (patch)
tree87bd65985bc1792e9182ed7a50da6659e907b65f
parent3a151a207bc323fc39e27b7d7bbe7989e34cebaf (diff)
downloadflac-3bb5d8cd761a2bd47a1a03366e00f5c83f88fedc.tar.gz
include: Escape number signs to suppress warnings
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.
-rw-r--r--include/FLAC++/export.h6
-rw-r--r--include/FLAC/all.h6
-rw-r--r--include/FLAC/export.h6
3 files changed, 9 insertions, 9 deletions
diff --git a/include/FLAC++/export.h b/include/FLAC++/export.h
index 6776b29c..d8dccf54 100644
--- a/include/FLAC++/export.h
+++ b/include/FLAC++/export.h
@@ -36,7 +36,7 @@
/** \file include/FLAC++/export.h
*
* \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.
*
* See the \link flacpp_export export \endlink module.
@@ -46,7 +46,7 @@
* \ingroup flacpp
*
* \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.
*
* If you are compiling with MSVC and will link to the static library
@@ -74,7 +74,7 @@
#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
*/
#define FLACPP_API_VERSION_CURRENT 9
diff --git a/include/FLAC/all.h b/include/FLAC/all.h
index b37a68fc..6ba03c19 100644
--- a/include/FLAC/all.h
+++ b/include/FLAC/all.h
@@ -147,7 +147,7 @@
* library.
*
* 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
* binaries.
*/
@@ -159,9 +159,9 @@
* the libraries to newer versions of FLAC.
*
* 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
- * \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>,
* e.g. in libFLAC there are \c FLAC_API_VERSION_CURRENT,
* \c FLAC_API_VERSION_REVISION, and \c FLAC_API_VERSION_AGE.
diff --git a/include/FLAC/export.h b/include/FLAC/export.h
index 628fe5fc..3e3e7648 100644
--- a/include/FLAC/export.h
+++ b/include/FLAC/export.h
@@ -36,7 +36,7 @@
/** \file include/FLAC/export.h
*
* \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.
*
* See the \link flac_export export \endlink module.
@@ -46,7 +46,7 @@
* \ingroup flac
*
* \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.
*
* If you are compiling with MSVC and will link to the static library
@@ -74,7 +74,7 @@
#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
*/
#define FLAC_API_VERSION_CURRENT 11