From ab597027ea98d4fa39980f9674dced42b5193b79 Mon Sep 17 00:00:00 2001 From: Paul Fertser Date: Tue, 16 Jan 2018 15:08:34 +0300 Subject: [PATCH 1/1] doxygen: fix issues with recent Doxygen versions This fixes parsing of several documentation files which do not have dot in the filename. style.txt change fixes doxygen warnings and ensures proper display of comment begin/end instructions in HTML. Tested with Doxygen 1.8.13. Change-Id: I9fd9ac3b51b47076b8fdbd3e93b90c3eba9b9631 Signed-off-by: Paul Fertser Reviewed-on: http://openocd.zylin.com/4342 Tested-by: jenkins --- Doxyfile.in | 2 +- doc/manual/style.txt | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Doxyfile.in b/Doxyfile.in index 13b0c24f63..6e68b4e373 100644 --- a/Doxyfile.in +++ b/Doxyfile.in @@ -216,7 +216,7 @@ OPTIMIZE_OUTPUT_VHDL = NO # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C -EXTENSION_MAPPING = +EXTENSION_MAPPING = no_extension=C # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should diff --git a/doc/manual/style.txt b/doc/manual/style.txt index 2ff2a29eed..0bfae35f70 100644 --- a/doc/manual/style.txt +++ b/doc/manual/style.txt @@ -176,10 +176,10 @@ comments. * @returns The value(s) returned, or possible error conditions. */ @endverbatim - -# The block should start on the line following the opening @c /**. - -# The end of the block, \f$*/\f$, should also be on its own line. + -# The block should start on the line following the opening @c /\**. + -# The end of the block, @c *‍/, should also be on its own line. -# Every line in the block should have a @c '*' in-line with its start: - - A leading space is required to align the @c '*' with the @c /** line. + - A leading space is required to align the @c '*' with the @c /\** line. - A single "empty" line should separate the function documentation from the block of parameter and return value descriptions. - Except to separate paragraphs of documentation, other extra -- 2.30.2