Doxygen example

Replace the unnecessarily large number of doxygen examples with one
doxygen example.

Examples/java/doxygen/Makefile

@@ -0,0 +1,21 @@
+TOP        = ../..
+SWIGEXE    = $(TOP)/../swig
+SWIG_LIB_DIR = $(TOP)/../$(TOP_BUILDDIR_TO_TOP_SRCDIR)Lib
+CXXSRCS    = example.cxx
+TARGET     = example
+INTERFACE  = example.i
+SWIGOPT    = -doxygen
+JAVASRCS   = *.java
+
+check: build
+	$(MAKE) -f $(TOP)/Makefile SRCDIR='$(SRCDIR)' java_run
+
+build:
+	$(MAKE) -f $(TOP)/Makefile SRCDIR='$(SRCDIR)' CXXSRCS='$(CXXSRCS)' \
+	SWIG_LIB_DIR='$(SWIG_LIB_DIR)' SWIGEXE='$(SWIGEXE)' \
+	SWIGOPT='$(SWIGOPT)' TARGET='$(TARGET)' INTERFACE='$(INTERFACE)' java_cpp
+	$(MAKE) -f $(TOP)/Makefile SRCDIR='$(SRCDIR)' JAVASRCS='$(JAVASRCS)' JAVAFLAGS='$(JAVAFLAGS)' java_compile
+
+clean:
+	$(MAKE) -f $(TOP)/Makefile SRCDIR='$(SRCDIR)' java_clean
+	rm -rf javadocs

Examples/java/doxygen/example.cxx

@@ -0,0 +1,48 @@
+/* File : example.cxx */
+
+#include "example.h"
+#define M_PI 3.14159265358979323846
+
+/* Move the shape to a new location */
+void Shape::move(double dx, double dy) {
+  x += dx;
+  y += dy;
+}
+
+int Shape::nshapes = 0;
+
+Circle::Circle(double r) : radius(r) {
+  NumCircles++;
+}
+
+double Circle::area() {
+  return M_PI*radius*radius;
+}
+
+double Circle::perimeter() {
+  return 2*M_PI*radius;
+}
+
+Square::Square(double w) : width(w) {
+  NumSquares++;
+}
+
+double Square::area() {
+  return width*width;
+}
+
+double Square::perimeter() {
+  return 4*width;
+}
+
+int NumSquares = 0;
+int NumCircles = 0;
+
+Square MakeSquare(double r) {
+  return Square(r);
+}
+
+Circle MakeCircle(double w) {
+  return Circle(w);
+}
+

Examples/java/doxygen/example.dsp

@@ -0,0 +1,162 @@
+# Microsoft Developer Studio Project File - Name="example" - Package Owner=<4>
+# Microsoft Developer Studio Generated Build File, Format Version 6.00
+# ** DO NOT EDIT **
+
+# TARGTYPE "Win32 (x86) Dynamic-Link Library" 0x0102
+
+CFG=example - Win32 Release
+!MESSAGE This is not a valid makefile. To build this project using NMAKE,
+!MESSAGE use the Export Makefile command and run
+!MESSAGE 
+!MESSAGE NMAKE /f "example.mak".
+!MESSAGE 
+!MESSAGE You can specify a configuration when running NMAKE
+!MESSAGE by defining the macro CFG on the command line. For example:
+!MESSAGE 
+!MESSAGE NMAKE /f "example.mak" CFG="example - Win32 Release"
+!MESSAGE 
+!MESSAGE Possible choices for configuration are:
+!MESSAGE 
+!MESSAGE "example - Win32 Debug" (based on "Win32 (x86) Dynamic-Link Library")
+!MESSAGE "example - Win32 Release" (based on "Win32 (x86) Dynamic-Link Library")
+!MESSAGE 
+
+# Begin Project
+# PROP AllowPerConfigDependencies 0
+# PROP Scc_ProjName ""
+# PROP Scc_LocalPath ""
+CPP=cl.exe
+MTL=midl.exe
+RSC=rc.exe
+
+!IF  "$(CFG)" == "example - Win32 Debug"
+
+# PROP BASE Use_MFC 0
+# PROP BASE Use_Debug_Libraries 1
+# PROP BASE Output_Dir "Debug"
+# PROP BASE Intermediate_Dir "Debug"
+# PROP BASE Target_Dir ""
+# PROP Use_MFC 0
+# PROP Use_Debug_Libraries 1
+# PROP Output_Dir "Debug"
+# PROP Intermediate_Dir "Debug"
+# PROP Ignore_Export_Lib 0
+# PROP Target_Dir ""
+# ADD BASE CPP /nologo /MTd /W3 /Gm /GX /ZI /Od /D "WIN32" /D "_DEBUG" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "EXAMPLE_EXPORTS" /YX /FD /GZ /c
+# ADD CPP /nologo /MTd /W3 /Gm /GX /ZI /Od /I "$(JAVA_INCLUDE)" /I "$(JAVA_INCLUDE)\win32" /D "WIN32" /D "_DEBUG" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "EXAMPLE_EXPORTS" /YX /FD /GZ /c
+# ADD BASE MTL /nologo /D "_DEBUG" /mktyplib203 /win32
+# ADD MTL /nologo /D "_DEBUG" /mktyplib203 /win32
+# ADD BASE RSC /l 0x809 /d "_DEBUG"
+# ADD RSC /l 0x809 /d "_DEBUG"
+BSC32=bscmake.exe
+# ADD BASE BSC32 /nologo
+# ADD BSC32 /nologo
+LINK32=link.exe
+# ADD BASE LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib /nologo /dll /debug /machine:I386 /pdbtype:sept
+# ADD LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib /nologo /dll /debug /machine:I386 /out:"example.dll" /pdbtype:sept
+# Begin Special Build Tool
+SOURCE="$(InputPath)"
+PostBuild_Desc=Java compile post-build step
+PostBuild_Cmds=echo on	"%JAVA_BIN%\javac" *.java
+# End Special Build Tool
+
+!ELSEIF  "$(CFG)" == "example - Win32 Release"
+
+# PROP BASE Use_MFC 0
+# PROP BASE Use_Debug_Libraries 0
+# PROP BASE Output_Dir "Release"
+# PROP BASE Intermediate_Dir "Release"
+# PROP BASE Target_Dir ""
+# PROP Use_MFC 0
+# PROP Use_Debug_Libraries 0
+# PROP Output_Dir "Release"
+# PROP Intermediate_Dir "Release"
+# PROP Ignore_Export_Lib 0
+# PROP Target_Dir ""
+# ADD BASE CPP /nologo /MT /W3 /GX /O2 /D "WIN32" /D "NDEBUG" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "EXAMPLE_EXPORTS" /YX /FD /c
+# ADD CPP /nologo /MT /W3 /GX /O2 /I "$(JAVA_INCLUDE)" /I "$(JAVA_INCLUDE)\win32" /D "WIN32" /D "NDEBUG" /D "_WINDOWS" /D "_MBCS" /D "_USRDLL" /D "EXAMPLE_EXPORTS" /YX /FD /c
+# ADD BASE MTL /nologo /D "NDEBUG" /mktyplib203 /win32
+# ADD MTL /nologo /D "NDEBUG" /mktyplib203 /win32
+# ADD BASE RSC /l 0x809 /d "NDEBUG"
+# ADD RSC /l 0x809 /d "NDEBUG"
+BSC32=bscmake.exe
+# ADD BASE BSC32 /nologo
+# ADD BSC32 /nologo
+LINK32=link.exe
+# ADD BASE LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib /nologo /dll /machine:I386
+# ADD LINK32 kernel32.lib user32.lib gdi32.lib winspool.lib comdlg32.lib advapi32.lib shell32.lib ole32.lib oleaut32.lib uuid.lib /nologo /dll /machine:I386 /out:"example.dll"
+# Begin Special Build Tool
+SOURCE="$(InputPath)"
+PostBuild_Desc=Java compile post-build step
+PostBuild_Cmds=echo on	"%JAVA_BIN%\javac" *.java
+# End Special Build Tool
+
+!ENDIF 
+
+# Begin Target
+
+# Name "example - Win32 Debug"
+# Name "example - Win32 Release"
+# Begin Group "Source Files"
+
+# PROP Default_Filter "cpp;c;cxx;rc;def;r;odl;idl;hpj;bat"
+# Begin Source File
+
+SOURCE=.\example.cxx
+# End Source File
+# Begin Source File
+
+SOURCE=.\example_wrap.cxx
+# End Source File
+# End Group
+# Begin Group "Header Files"
+
+# PROP Default_Filter "h;hpp;hxx;hm;inl"
+# Begin Source File
+
+SOURCE=.\example.h
+# End Source File
+# End Group
+# Begin Group "Resource Files"
+
+# PROP Default_Filter "ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe"
+# End Group
+# Begin Source File
+
+SOURCE=.\example.i
+
+!IF  "$(CFG)" == "example - Win32 Debug"
+
+# Begin Custom Build
+InputPath=.\example.i
+InputName=example
+
+"$(InputName)_wrap.cxx" : $(SOURCE) "$(INTDIR)" "$(OUTDIR)"
+	echo In order to function correctly, please ensure the following environment variables are correctly set: 
+	echo JAVA_INCLUDE: %JAVA_INCLUDE% 
+	echo JAVA_BIN: %JAVA_BIN% 
+	echo on 
+	..\..\..\swig.exe -c++ -java "$(InputPath)" 
+	
+# End Custom Build
+
+!ELSEIF  "$(CFG)" == "example - Win32 Release"
+
+# Begin Custom Build
+InputPath=.\example.i
+InputName=example
+
+"$(InputName)_wrap.cxx" : $(SOURCE) "$(INTDIR)" "$(OUTDIR)"
+	echo In order to function correctly, please ensure the following environment variables are correctly set: 
+	echo JAVA_INCLUDE: %JAVA_INCLUDE% 
+	echo JAVA_BIN: %JAVA_BIN% 
+	echo on 
+	..\..\..\swig.exe -c++ -java "$(InputPath)" 
+	
+# End Custom Build
+
+!ENDIF 
+
+# End Source File
+# End Target
+# End Project

Examples/java/doxygen/example.h

@@ -0,0 +1,107 @@
+/*! \file example.h 
+This file provides a simple set of Shape classes. */
+
+/*! Base class for all shapes.
+ \author Bob
+ */
+class Shape {
+public:
+  /*! Default constructor for creating a Shape */
+  Shape() {
+    nshapes++;
+  }
+  /*! Destructor for destroying a Shape */
+  virtual ~Shape() {
+    nshapes--;
+  }
+  double x; /*!< x co-ordinate */
+  double y; /*!< y co-ordinate */
+  void    move(double dx, double dy); /*!< Move a shape to a new co-ordinate
+  \param dx x co-ordinate
+  \param dy y co-ordinate */
+  virtual double area() = 0; /*!< \return the area */
+  virtual double perimeter() = 0; /*!< \return the perimeter */
+  static  int nshapes; /*!< Number of shapes currently in existence */
+};
+
+/*! A class for representing a circle.
+ \author Jack
+ */
+class Circle : public Shape {
+private:
+  double radius;
+public:
+  /*! Construct a circle
+   *  \param r radius of the circle */
+  Circle(double r);
+  /*! Calculate the area of the circle
+   *  \return calculated area */
+  virtual double area();
+  /*! Calculate the perimeter of the circle
+   *  \return calculated perimeter of the circle */
+  virtual double perimeter();
+};
+
+/// A class for representing a square.
+class Square : public Shape {
+private:
+  double width;
+public:
+  /** Construct a square
+   *  \param w width of the square */
+  Square(double w);
+  /** Calculate the area of the square
+   *  \return calculated area */
+  virtual double area();
+  /** Calculate the perimeter of the square
+   *  \return calculated perimeter of the square */
+  virtual double perimeter();
+};
+
+/// A class for representing a rectangle, templated on the type for the rectangle dimensions
+template<typename T>
+class Rectangle : public Shape {
+private:
+  T height;
+  T width;
+public:
+  /** Construct a rectangle
+   *  \param h height of the rectangle
+   *  \param w width of the rectangle */
+  Rectangle(T h, T w) : height(h), width(w) {}
+  /** Calculate the area of the rectangle
+   *  \return calculated area */
+  virtual double area() { return width*height; }
+  /** Calculate the perimeter of the rectangle
+   *  \return calculated perimeter of the rectangle */
+  virtual double perimeter() { return 2*height + 2*width; }
+};
+
+
+/*! Factory function for creating a square
+ *  \param r width of the square
+ *  \return a fully constructed square */
+Square MakeSquare(double r);
+
+/*! Factory function for creating a circle
+ *  \param w radius of the circle
+ *  \return a fully constructed circle */
+Circle MakeCircle(double w);
+
+/*! Factory function for creating a rectangle
+ *  \param h height of the rectangle
+ *  \param w width of the rectangle
+ *  \return a fully constructed rectangle */
+template<typename T>
+Rectangle<T> MakeRectangle(T h, T w) {
+  return Rectangle<T>(h, w);
+}
+
+
+
+/*! Total number of circles ever created */
+extern int NumCircles;
+
+/// Total number of squares ever created
+extern int NumSquares;
+

Examples/java/doxygen/example.i

@@ -0,0 +1,17 @@
+%module example
+
+%{
+#include "example.h"
+%}
+
+%immutable NumSquares;
+%immutable NumCircles;
+
+%include "example.h"
+
+/*! - this instantiation uses type int */
+%template(RectangleInt) Rectangle<int>;
+
+/*! - this instantiation uses type int */
+%template(MakeRectangleInt) MakeRectangle<int>;
+

Examples/java/doxygen/runme.java

@@ -0,0 +1,63 @@
+// This example shows simple usage of the wrapped Shape classes.
+// The main purpose of this example is to show the doxygen comments translation to JavaDoc comments.
+// Users should look at the generated .java files and if javadoc is installed and working on your system,
+// the generated Java docs can be viewed in a browser by opening the javadocs/index.html file.
+
+import java.io.*;
+
+public class runme {
+  static {
+    try {
+        System.loadLibrary("example");
+    } catch (UnsatisfiedLinkError e) {
+      System.err.println("Native code library failed to load. See the chapter on Dynamic Linking Problems in the SWIG Java documentation for help.\n" + e);
+      System.exit(1);
+    }
+  }
+
+  public static void main(String argv[]) throws InterruptedException, IOException
+  {
+    System.out.println("Creating some objects:");
+    Circle c = example.MakeCircle(10);
+    System.out.println("    Created circle " + c);
+    Square s = example.MakeSquare(10);
+    System.out.println("    Created square " + s);
+    RectangleInt r = example.MakeRectangleInt(10, 20);
+    System.out.println("    Created rectangle " + r);
+
+    System.out.println("\nHere are some properties of the shapes:");
+    Shape[] shapes = {c, s, r};
+    for (int i=0; i<shapes.length; i++) {
+      System.out.println("   " + shapes[i].toString());
+      System.out.println("        area      = " + shapes[i].area());
+      System.out.println("        perimeter = " + shapes[i].perimeter());
+    }
+
+    String command = "javadoc -quiet -public -d javadocs example.java Shape.java Circle.java Square.java RectangleInt.java";
+    System.out.println("\nRunning: " + command);
+    Process p = Runtime.getRuntime().exec(command);
+    int exitCode = p.waitFor();
+    System.out.println("javadoc exited with code " + exitCode);
+
+    BufferedReader stdout = new BufferedReader(new InputStreamReader(p.getInputStream()));
+    BufferedReader stderr = new BufferedReader(new InputStreamReader(p.getErrorStream()));
+
+    String line = null;
+
+    System.out.println("stdout from javadoc:\n");
+    while ((line = stdout.readLine()) != null) {
+      System.out.println(line);
+    }
+
+    System.out.println("\nstderr from javadoc:\n");
+    while ((line = stderr.readLine()) != null) {
+      System.out.println(line);
+    }
+
+    if (exitCode != 0) {
+      System.out.println("No java docs were generated!\n");
+    } else {
+      System.out.println("javadoc ran successfully, open javadocs/index.html in your browser to view the generated java docs.");
+    }
+  }
+}