Doxygen source rename

Source/DoxygenTranslator/src directory is renamed Source/Doxygen
Renamed files in this directory to short names using lowercase as is the
convention for the rest of the SWIG source.
C++ extension is also .cxx like other SWIG source code.

I used doxy as the prefix for most file renames because without this
Doxygen/parser.* would be easily confused with CParse/parser.* so
Doxygen/doxyparser.* is renamed from DoxygenTranslator/src/DoxygenParser.*

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

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.
 </p>
 <p>

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.
  * ----------------------------------------------------------------------------- */

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 <iostream>
 
 using std::cout;

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.
  * ----------------------------------------------------------------------------- */

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 "doxyparser.h"
-#include "DoxygenCommands.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;
 

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:

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) {
 }

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 "doxyentity.h"
-#include "DoxygenParser.h"
+#include "doxyparser.h"
 #include <list>
 #include <string>
 

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 "javadoc.h"
-#include "DoxygenParser.h"
+#include "doxyparser.h"
 #include <iostream>
 #include <vector>
 #include <list>
-#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

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 <map>
 
 /*

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 "pydoc.h"
-#include "DoxygenParser.h"
+#include "doxyparser.h"
 #include <sstream>
 #include <string>
 #include <vector>

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 <list>
 #include <string>
 #include "swig.h"
-#include "DoxygenEntity.h"
+#include "doxyentity.h"
-#include "DoxygenTranslator.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

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			\
+		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
 
 bin_PROGRAMS = eswig
 eswig_LDADD   = @SWIGLIBS@

Source/Modules/java.cxx

@@ -15,7 +15,7 @@
 #include <limits.h>		// for INT_MAX
 #include "cparse.h"
 #include <ctype.h>
-#include "../DoxygenTranslator/src/JavaDocConverter.h"
+#include "../Doxygen/javadoc.h"
 
 /* Hash type used for upcalls from C/C++ */
 typedef DOH UpcallData;

Source/Modules/python.cxx

@@ -17,7 +17,7 @@
 #include <ctype.h>
 #include <errno.h>
 #include <stdlib.h>
-#include "../DoxygenTranslator/src/PyDocConverter.h"
+#include "../Doxygen/pydoc.h"
 
 #include <iostream>
 #include <stdint.h>