[vlc-commits] vector: use code instead of verbatim in doxygen

[Alexandre Janniaux]

vlc | branch: master | Alexandre Janniaux <***@gmail.com> | Sun Dec 9 15:50:28 2018 +0100| [81271098e119de07df7031ddd15bd8006ebcf37a] | committer: Rémi Denis-Courmont

vector: use code instead of verbatim in doxygen

Verbatim is dedicated to render monospaced unfiltered text. While code
can fit this description, code environment is better suited as it gets
syntax coloration and avoid the need to remove the stars before the
lines of code.

http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=81271098e119de07df7031ddd15bd8006ebcf37a

---

include/vlc_vector.h | 12 ++++++------
1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/include/vlc_vector.h b/include/vlc_vector.h
index 54cf62a1d7..2f6070c763 100644
--- a/include/vlc_vector.h
+++ b/include/vlc_vector.h
@@ -39,21 +39,21 @@
*
* To use a vector, a new type must be defined:
*
- * \verbatim
+ * \code
* struct vec_int VLC_VECTOR(int);
- * \endverbatim
+ * \endcode
*
* The struct may be anonymous:
*
- * \verbatim
+ * \code
* struct VLC_VECTOR(const char *) names;
- * \endverbatim
+ * \endcode
*
* It is convenient to define a typedef to an anonymous structure:
*
- * \verbatim
+ * \code
* typedef struct VLC_VECTOR(int) vec_int_t;
- * \endverbatim
+ * \endcode
*
* Vector size is accessible via `vec.size`, and items are intended to be
* accessed directly, via `vec.data[i]`.