Skip to content

Commit

Permalink
Use doxygen commands instead of HTML escapes
Browse files Browse the repository at this point in the history
In our documentation, we show which header file to include for each
libcork module.  This patch updates those include lines to use the
doxygen \< and \> commands, instead of the HTML &lt; and &gt; escapes.
It just looks a bit cleaner.
  • Loading branch information
Douglas Creager committed Jun 20, 2011
1 parent d1d6339 commit 5f86a8b
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion include/libcork/core.h
Expand Up @@ -19,7 +19,7 @@
/**
* @defgroup core Core module
*
* <tt>#%include &lt;libcork/core.h&gt;</tt>
* <tt>#%include \<libcork/core.h\></tt>
*/

/*** order of groups in documentation ***/
Expand Down
6 changes: 3 additions & 3 deletions include/libcork/core/byte-order.h
Expand Up @@ -22,7 +22,7 @@
/**
* @addtogroup byte_order Byte order
*
* <tt>#%include &lt;libcork/core/byte-order.h&gt;</tt>
* <tt>#%include \<libcork/core/byte-order.h\></tt>
*
* This section contains definitions for determining the endianness of
* the host system, and for byte-swapping integer values of various
Expand All @@ -37,7 +37,7 @@
* @defgroup endianness Endianness detection
* @ingroup byte_order
*
* <tt>#%include &lt;libcork/core/byte-order.h&gt;</tt>
* <tt>#%include \<libcork/core/byte-order.h\></tt>
*
* The macros in this section can be used to determine the endianness of
* the current system. We also provide a C string constant for the
Expand Down Expand Up @@ -160,7 +160,7 @@
* @defgroup byteswap Byte swapping macros
* @ingroup byte_order
*
* <tt>#%include &lt;libcork/core/byte-order.h&gt;</tt>
* <tt>#%include \<libcork/core/byte-order.h\></tt>
*
* The macros in this section can be used to swap integer values of
* various sizes. There are a couple variations for each integer types:
Expand Down

0 comments on commit 5f86a8b

Please sign in to comment.