From f25d03612b3bfc376f561a8b2d4dd4e6a6110cc0 Mon Sep 17 00:00:00 2001 From: Marko Klopcic Date: Thu, 17 Jan 2013 23:17:06 +0100 Subject: [PATCH] added the missing doxy command 'example' --- Examples/test-suite/java/doxygen_translate_runme.java | 5 ++++- Source/DoxygenTranslator/src/JavaDocConverter.cpp | 3 +++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/Examples/test-suite/java/doxygen_translate_runme.java b/Examples/test-suite/java/doxygen_translate_runme.java index 831dc4f83..55342ef55 100644 --- a/Examples/test-suite/java/doxygen_translate_runme.java +++ b/Examples/test-suite/java/doxygen_translate_runme.java @@ -52,7 +52,10 @@ public class doxygen_translate_runme { " \n" + " italicword \n" + " \n" + - " @exception SuperError \n" + + " @ example someFile.txt\n" + + " Some details on using the example\n" + + " \n" + + " @exception SuperError \n" + " \n" + " If: ANOTHERCONDITION {\n" + " First part of comment \n" + diff --git a/Source/DoxygenTranslator/src/JavaDocConverter.cpp b/Source/DoxygenTranslator/src/JavaDocConverter.cpp index 2a02af348..bd592adc2 100644 --- a/Source/DoxygenTranslator/src/JavaDocConverter.cpp +++ b/Source/DoxygenTranslator/src/JavaDocConverter.cpp @@ -126,6 +126,9 @@ void JavaDocConverter::fillStaticTables() { tagHandlers["else"] = make_pair(&JavaDocConverter::handleTagIf, "Else: "); tagHandlers["elseif"] = make_pair(&JavaDocConverter::handleTagIf, "Else if: "); tagHandlers["endcond"] = make_pair(&JavaDocConverter::handleTagMessage, "End of conditional comment."); + // space prevents Javadoc to treat '@ example' as command. File name of + // example is still informative to user. + tagHandlers["example"] = make_pair(&JavaDocConverter::handleTagSame, " example"); tagHandlers["if"] = make_pair(&JavaDocConverter::handleTagIf, "If: "); tagHandlers["ifnot"] = make_pair(&JavaDocConverter::handleTagIf, "If not: "); tagHandlers["image"] = make_pair(&JavaDocConverter::handleTagImage, "");