From: Uwe Hermann <redacted>
Date: Sun, 5 Jan 2020 17:17:04 +0000 (+0100)
Subject: Doxygen: Fix an issue causing missing #define documentation output.
X-Git-Url: https://sigrok.org/gitweb/?p=libserialport.git;a=commitdiff_plain;h=44df4154801cb101d6f80d466e04ed19a1abac9c

Doxygen: Fix an issue causing missing #define documentation output.

  Searching for documented defines...
  [...]libserialport.h:1624: warning: documentation for unknown define SP_PACKAGE_VERSION_MAJOR found.
  [...]libserialport.h:1627: warning: documentation for unknown define SP_PACKAGE_VERSION_MINOR found.
  [...]libserialport.h:1630: warning: documentation for unknown define SP_PACKAGE_VERSION_MICRO found.
  [...]libserialport.h:1633: warning: documentation for unknown define SP_PACKAGE_VERSION_STRING found.
  [...]libserialport.h:1640: warning: documentation for unknown define SP_LIB_VERSION_CURRENT found.
  [...]libserialport.h:1643: warning: documentation for unknown define SP_LIB_VERSION_REVISION found.
  [...]libserialport.h:1646: warning: documentation for unknown define SP_LIB_VERSION_AGE found.
  [...]libserialport.h:1649: warning: documentation for unknown define SP_LIB_VERSION_STRING found.
---

diff --git a/libserialport.h.in b/libserialport.h.in
index 1916283..67df3d7 100644
--- a/libserialport.h.in
+++ b/libserialport.h.in
@@ -77,7 +77,10 @@
  * -------
  *
  * To use libserialport functions in your code, you should include the
- * libserialport.h header, i.e. {@code #include <libserialport.h>}
+ * libserialport.h header, i.e.
+ * @code
+ * #include <libserialport.h>
+ * @endcode
  *
  * Namespace
  * ---------