diff --git a/Doc/Devel/plan-gsoc-2012.txt b/Doc/Devel/plan-gsoc-2012.txt index 51d387d3c..ac764fb2a 100644 --- a/Doc/Devel/plan-gsoc-2012.txt +++ b/Doc/Devel/plan-gsoc-2012.txt @@ -321,7 +321,7 @@ make doxygen_tricky_constructs.cpptest -s Refactoring =========== -All the code in directory _DoxygenTranslator_ should be refactored: +All the code in directory _Doxygen_ should be refactored: -OK- all methods should be class members -OK- most static methods should be normal members -OK- replace C arrays of strings and sequential searches with STL data diff --git a/Doc/Manual/Doxygen.html b/Doc/Manual/Doxygen.html index 08d1aef94..842f146d8 100644 --- a/Doc/Manual/Doxygen.html +++ b/Doc/Manual/Doxygen.html @@ -1741,7 +1741,7 @@ Searching for "doxygen" in the java.cxx module can give you a good idea of the p The basic gist is that anywhere a comment may reside on a node, there needs to be a catch for it in front of where that function, class, or other object is written out to a target language file. The other half of extension is building a target documentation language comment generator that handles one blob at a time. However, this is relatively simple and nowhere near as complex as the wrapper generating modules in SWIG. -See DoxygenTranslator/JavaDocConverter.cpp for a good example. +See Source/Doxygen/javadoc.cxx for a good example. The target language module passes the Doxygen Translator the blob to translate, and receives back the translated text.

diff --git a/Source/DoxygenTranslator/src/DoxygenCommands.h b/Source/Doxygen/doxycommands.h similarity index 99% rename from Source/DoxygenTranslator/src/DoxygenCommands.h rename to Source/Doxygen/doxycommands.h index eca148a50..1f7b5fa5b 100644 --- a/Source/DoxygenTranslator/src/DoxygenCommands.h +++ b/Source/Doxygen/doxycommands.h @@ -6,7 +6,7 @@ * included with the SWIG source code as distributed by the SWIG developers * and at http://www.swig.org/legal.html. * - * DoxygenCommands.h + * doxycommands.h * * Part of the Doxygen comment translation module of SWIG. * ----------------------------------------------------------------------------- */ diff --git a/Source/DoxygenTranslator/src/DoxygenEntity.cpp b/Source/Doxygen/doxyentity.cxx similarity index 97% rename from Source/DoxygenTranslator/src/DoxygenEntity.cpp rename to Source/Doxygen/doxyentity.cxx index 7e977ee9b..8b9f65736 100644 --- a/Source/DoxygenTranslator/src/DoxygenEntity.cpp +++ b/Source/Doxygen/doxyentity.cxx @@ -6,12 +6,12 @@ * included with the SWIG source code as distributed by the SWIG developers * and at http://www.swig.org/legal.html. * - * DoxygenEntity.cpp + * doxyentity.cxx * * Part of the Doxygen comment translation module of SWIG. * ----------------------------------------------------------------------------- */ -#include "DoxygenEntity.h" +#include "doxyentity.h" #include using std::cout; diff --git a/Source/DoxygenTranslator/src/DoxygenEntity.h b/Source/Doxygen/doxyentity.h similarity index 98% rename from Source/DoxygenTranslator/src/DoxygenEntity.h rename to Source/Doxygen/doxyentity.h index 3c243462c..93737e604 100644 --- a/Source/DoxygenTranslator/src/DoxygenEntity.h +++ b/Source/Doxygen/doxyentity.h @@ -6,7 +6,7 @@ * included with the SWIG source code as distributed by the SWIG developers * and at http://www.swig.org/legal.html. * - * DoxygenEntity.h + * doxyentity.h * * Part of the Doxygen comment translation module of SWIG. * ----------------------------------------------------------------------------- */ diff --git a/Source/DoxygenTranslator/src/DoxygenParser.cpp b/Source/Doxygen/doxyparser.cxx similarity index 99% rename from Source/DoxygenTranslator/src/DoxygenParser.cpp rename to Source/Doxygen/doxyparser.cxx index 4c7bcdd1c..558b0401f 100644 --- a/Source/DoxygenTranslator/src/DoxygenParser.cpp +++ b/Source/Doxygen/doxyparser.cxx @@ -6,11 +6,11 @@ * included with the SWIG source code as distributed by the SWIG developers * and at http://www.swig.org/legal.html. * - * DoxygenParser.cpp + * doxyparser.cxx * ----------------------------------------------------------------------------- */ -#include "DoxygenParser.h" -#include "DoxygenCommands.h" +#include "doxyparser.h" +#include "doxycommands.h" #include "swig.h" #include "swigwarn.h" @@ -46,7 +46,7 @@ void DoxygenParser::fillTables() { if (doxygenCommands.size()) return; - // fill in tables with data from DoxygenCommands.h + // fill in tables with data from doxycommands.h for (int i = 0; i < simpleCommandsSize; i++) doxygenCommands[simpleCommands[i]] = SIMPLECOMMAND; diff --git a/Source/DoxygenTranslator/src/DoxygenParser.h b/Source/Doxygen/doxyparser.h similarity index 99% rename from Source/DoxygenTranslator/src/DoxygenParser.h rename to Source/Doxygen/doxyparser.h index ec5e24cc2..96c71d22f 100644 --- a/Source/DoxygenTranslator/src/DoxygenParser.h +++ b/Source/Doxygen/doxyparser.h @@ -6,7 +6,7 @@ * included with the SWIG source code as distributed by the SWIG developers * and at http://www.swig.org/legal.html. * - * DoxygenParser.h + * doxyparser.h * ----------------------------------------------------------------------------- */ #ifndef DOXYGENPARSER_H_ @@ -19,7 +19,7 @@ #include "swig.h" -#include "DoxygenEntity.h" +#include "doxyentity.h" class DoxygenParser { private: diff --git a/Source/DoxygenTranslator/src/DoxygenTranslator.cpp b/Source/Doxygen/doxytranslator.cxx similarity index 96% rename from Source/DoxygenTranslator/src/DoxygenTranslator.cpp rename to Source/Doxygen/doxytranslator.cxx index bd5963973..2684adcea 100644 --- a/Source/DoxygenTranslator/src/DoxygenTranslator.cpp +++ b/Source/Doxygen/doxytranslator.cxx @@ -6,13 +6,13 @@ * included with the SWIG source code as distributed by the SWIG developers * and at http://www.swig.org/legal.html. * - * DoxygenTranslator.cpp + * doxytranslator.cxx * * Module to return documentation for nodes formatted for various documentation * systems. * ----------------------------------------------------------------------------- */ -#include "DoxygenTranslator.h" +#include "doxytranslator.h" DoxygenTranslator::DoxygenTranslator(int flags) : m_flags(flags), parser((flags &debug_parser) != 0) { } diff --git a/Source/DoxygenTranslator/src/DoxygenTranslator.h b/Source/Doxygen/doxytranslator.h similarity index 96% rename from Source/DoxygenTranslator/src/DoxygenTranslator.h rename to Source/Doxygen/doxytranslator.h index 35e521898..ffc378a7b 100644 --- a/Source/DoxygenTranslator/src/DoxygenTranslator.h +++ b/Source/Doxygen/doxytranslator.h @@ -6,7 +6,7 @@ * included with the SWIG source code as distributed by the SWIG developers * and at http://www.swig.org/legal.html. * - * DoxygenTranslator.h + * doxytranslator.h * * Module to return documentation for nodes formatted for various documentation * systems. @@ -16,8 +16,8 @@ #define DOXYGENTRANSLATOR_H_ #include "swig.h" -#include "DoxygenEntity.h" -#include "DoxygenParser.h" +#include "doxyentity.h" +#include "doxyparser.h" #include #include diff --git a/Source/DoxygenTranslator/src/JavaDocConverter.cpp b/Source/Doxygen/javadoc.cxx similarity index 99% rename from Source/DoxygenTranslator/src/JavaDocConverter.cpp rename to Source/Doxygen/javadoc.cxx index c2fd8577e..3b81c55a5 100644 --- a/Source/DoxygenTranslator/src/JavaDocConverter.cpp +++ b/Source/Doxygen/javadoc.cxx @@ -6,15 +6,15 @@ * included with the SWIG source code as distributed by the SWIG developers * and at http://www.swig.org/legal.html. * - * JavaDocConverter.cpp + * javadoc.cxx * ----------------------------------------------------------------------------- */ -#include "JavaDocConverter.h" -#include "DoxygenParser.h" +#include "javadoc.h" +#include "doxyparser.h" #include #include #include -#include "../../Modules/swigmod.h" +#include "swigmod.h" #define APPROX_LINE_LENGTH 64 // characters per line allowed #define TAB_SIZE 8 // current tab size in spaces //TODO {@link} {@linkplain} {@docRoot}, and other useful doxy commands that are not a javadoc tag diff --git a/Source/DoxygenTranslator/src/JavaDocConverter.h b/Source/Doxygen/javadoc.h similarity index 99% rename from Source/DoxygenTranslator/src/JavaDocConverter.h rename to Source/Doxygen/javadoc.h index 100a77818..6feff5295 100644 --- a/Source/DoxygenTranslator/src/JavaDocConverter.h +++ b/Source/Doxygen/javadoc.h @@ -6,7 +6,7 @@ * included with the SWIG source code as distributed by the SWIG developers * and at http://www.swig.org/legal.html. * - * JavaDocConverter.h + * javadoc.h * * Module to return documentation for nodes formatted for JavaDoc * ----------------------------------------------------------------------------- */ @@ -14,7 +14,7 @@ #ifndef JAVADOCCONVERTER_H_ #define JAVADOCCONVERTER_H_ -#include "DoxygenTranslator.h" +#include "doxytranslator.h" #include /* diff --git a/Source/DoxygenTranslator/src/PyDocConverter.cpp b/Source/Doxygen/pydoc.cxx similarity index 99% rename from Source/DoxygenTranslator/src/PyDocConverter.cpp rename to Source/Doxygen/pydoc.cxx index 5edf7fa18..0f8484d6b 100644 --- a/Source/DoxygenTranslator/src/PyDocConverter.cpp +++ b/Source/Doxygen/pydoc.cxx @@ -6,13 +6,13 @@ * included with the SWIG source code as distributed by the SWIG developers * and at http://www.swig.org/legal.html. * - * PyDocConverter.cpp + * pydoc.cxx * * Module to return documentation for nodes formatted for PyDoc * ----------------------------------------------------------------------------- */ -#include "PyDocConverter.h" -#include "DoxygenParser.h" +#include "pydoc.h" +#include "doxyparser.h" #include #include #include diff --git a/Source/DoxygenTranslator/src/PyDocConverter.h b/Source/Doxygen/pydoc.h similarity index 98% rename from Source/DoxygenTranslator/src/PyDocConverter.h rename to Source/Doxygen/pydoc.h index 88e8f1f91..8f432fd18 100644 --- a/Source/DoxygenTranslator/src/PyDocConverter.h +++ b/Source/Doxygen/pydoc.h @@ -6,7 +6,7 @@ * included with the SWIG source code as distributed by the SWIG developers * and at http://www.swig.org/legal.html. * - * PyDocConverter.h + * pydoc.h * * Module to return documentation for nodes formatted for PyDoc * ----------------------------------------------------------------------------- */ @@ -17,8 +17,8 @@ #include #include #include "swig.h" -#include "DoxygenEntity.h" -#include "DoxygenTranslator.h" +#include "doxyentity.h" +#include "doxytranslator.h" #define DOC_STRING_LENGTH 64 // characters per line allowed #define DOC_PARAM_STRING_LENGTH 30 // characters reserved for param name / type diff --git a/Source/Makefile.am b/Source/Makefile.am index b1d6359b0..df3d4b75f 100644 --- a/Source/Makefile.am +++ b/Source/Makefile.am @@ -34,6 +34,16 @@ eswig_SOURCES = CParse/cscanner.c \ DOH/memory.c \ DOH/string.c \ DOH/void.c \ + Doxygen/doxyentity.cxx \ + Doxygen/doxyentity.h \ + Doxygen/doxyparser.cxx \ + Doxygen/doxyparser.h \ + Doxygen/doxytranslator.cxx \ + Doxygen/doxytranslator.h \ + Doxygen/javadoc.cxx \ + Doxygen/javadoc.h \ + Doxygen/pydoc.cxx \ + Doxygen/pydoc.h \ Modules/allegrocl.cxx \ Modules/allocate.cxx \ Modules/browser.cxx \ @@ -91,20 +101,10 @@ eswig_SOURCES = CParse/cscanner.c \ Swig/stype.c \ Swig/symbol.c \ Swig/tree.c \ - Swig/typeobj.c \ Swig/typemap.c \ + Swig/typeobj.c \ Swig/typesys.c \ - Swig/wrapfunc.c \ - DoxygenTranslator/src/DoxygenEntity.h\ - DoxygenTranslator/src/DoxygenEntity.cpp\ - DoxygenTranslator/src/DoxygenParser.h\ - DoxygenTranslator/src/DoxygenParser.cpp\ - DoxygenTranslator/src/DoxygenTranslator.h\ - DoxygenTranslator/src/DoxygenTranslator.cpp\ - DoxygenTranslator/src/JavaDocConverter.h\ - DoxygenTranslator/src/JavaDocConverter.cpp\ - DoxygenTranslator/src/PyDocConverter.h\ - DoxygenTranslator/src/PyDocConverter.cpp + Swig/wrapfunc.c bin_PROGRAMS = eswig eswig_LDADD = @SWIGLIBS@ diff --git a/Source/Modules/java.cxx b/Source/Modules/java.cxx index 7a4bc8214..12da307cf 100644 --- a/Source/Modules/java.cxx +++ b/Source/Modules/java.cxx @@ -15,7 +15,7 @@ #include // for INT_MAX #include "cparse.h" #include -#include "../DoxygenTranslator/src/JavaDocConverter.h" +#include "../Doxygen/javadoc.h" /* Hash type used for upcalls from C/C++ */ typedef DOH UpcallData; diff --git a/Source/Modules/python.cxx b/Source/Modules/python.cxx index 036124837..79edb6532 100644 --- a/Source/Modules/python.cxx +++ b/Source/Modules/python.cxx @@ -17,7 +17,7 @@ #include #include #include -#include "../DoxygenTranslator/src/PyDocConverter.h" +#include "../Doxygen/pydoc.h" #include #include