Merge pull request #6957 from cfriedt/feature/cfriedt/6955/allow-javadoc-style-comment-blocks-with-a-doxyfile-variable

Allow Javadoc-style comment blocks with a Doxyfile variable

2 files changed, 21 insertions, 0 deletions

diff --git a/doc/docblocks.doc b/doc/docblocks.doc
index d4eab5d..9d14f6e 100644
--- a/doc/docblocks.doc
+++ b/doc/docblocks.doc
@@ -123,6 +123,25 @@ or
 /////////////////////////////////////////////////
 \endverbatim
 
+or
+
+\verbatim
+/************************************************
+ *  ... text
+ ***********************************************/
+\endverbatim
+
+as long as JAVADOC_BANNER = YES is used.
+\include javadoc-banner.h
+ \htmlonly
+ Click <a href="examples/javadoc-banner/html/index.html">here</a>
+ for the corresponding HTML documentation that is generated by doxygen.
+ \endhtmlonly
+ \latexonly
+ See \hyperlink{javadoc_banner_example}{Javadoc Banner example}
+ for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen.
+ \endlatexonly
+
 </ol>
 
 For the brief description there are also several possibilities:
diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex
index 1a44574..5265b9b 100644
--- a/doc/doxygen_manual.tex
+++ b/doc/doxygen_manual.tex
@@ -178,6 +178,8 @@ Written by Dimitri van Heesch\\[2ex]
 \subinputfrom{../html/examples/file/latex/}{refman_doc}
 \chapter{Fn Example}\label{fn_example}\hypertarget{fn_example}{}
 \subinputfrom{../html/examples/func/latex/}{refman_doc}
+\chapter{Javadoc Banner Example}\label{javadoc_banner_example}\hypertarget{javadoc_banner_example}{}
+\subinputfrom{../html/examples/javadoc-banner/latex/}{refman_doc}
 \chapter{Overload Example}\label{overload_example}\hypertarget{overload_example}{}
 \subinputfrom{../html/examples/overload/latex/}{refman_doc}
 \chapter{Page Example}\label{page_example}\hypertarget{page_example}{}