#87: modified doxy config and code comments to nicely group things into separate namespaces and modules in the resulting .chm file

6 files changed, 35 insertions, 3 deletions

diff --git a/explore/.gitignore b/explore/.gitignore
new file mode 100644
index 00000000..c8ecd06a
--- /dev/null
+++ b/explore/.gitignore
@@ -0,0 +1,3 @@
+# doxygen output folders

+html

+latex
\ No newline at end of file
diff --git a/explore/Doxyfile b/explore/Doxyfile
index 415a1139..a94e6e94 100644
--- a/explore/Doxyfile
+++ b/explore/Doxyfile
@@ -855,7 +855,9 @@ EXCLUDE_SYMLINKS       = NO
 # Note that the wildcards are matched against the file with absolute path, so to
 # exclude all test directories for example use the pattern */test/*
 
-EXCLUDE_PATTERNS       = 
+EXCLUDE_PATTERNS       = */tests/* \
+                         */ExploreSample/* \
+                         */explore_sample.cpp/*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
diff --git a/explore/clr/explore_clr_wrapper.h b/explore/clr/explore_clr_wrapper.h
index 3c017bc9..f663eb9e 100644
--- a/explore/clr/explore_clr_wrapper.h
+++ b/explore/clr/explore_clr_wrapper.h
@@ -1,6 +1,10 @@
 #pragma once
 #include "explore_interop.h"
 
+/*!

+*  \addtogroup MultiWorldTestingCsharp

+*  @{

+*/
 namespace MultiWorldTesting {
 
 	/// <summary>

@@ -430,3 +434,5 @@ namespace MultiWorldTesting {
 		NativeMultiWorldTesting::SimpleContext* m_native_context;
 	};
 }
+
+/*! @} End of Doxygen Groups*/
\ No newline at end of file
diff --git a/explore/clr/explore_interface.h b/explore/clr/explore_interface.h
index a3cc7e3c..f79e7a2f 100644
--- a/explore/clr/explore_interface.h
+++ b/explore/clr/explore_interface.h
@@ -3,6 +3,12 @@
 using namespace System;
 using namespace System::Collections::Generic;
 
+/*!

+*  \addtogroup MultiWorldTestingCsharp

+*  @{

+*/
+
+//! Interface for C# version of Multiworld Testing library
 namespace MultiWorldTesting {
 
 /// <summary>

@@ -72,4 +78,6 @@ public:
 	virtual String^ ToString() = 0;

 };

 

-}
\ No newline at end of file
+}

+

+/*! @} End of Doxygen Groups*/
\ No newline at end of file
diff --git a/explore/static/MWTExplorer.h b/explore/static/MWTExplorer.h
index c500590d..079d7264 100644
--- a/explore/static/MWTExplorer.h
+++ b/explore/static/MWTExplorer.h
@@ -27,6 +27,12 @@ using namespace std;
 
 #include "utility.h"
 
+/*!

+*  \addtogroup MultiWorldTestingCpp

+*  @{

+*/
+
+//! Interface for C++ version of Multiworld Testing library
 MWT_NAMESPACE {
 
 // Forward declarations
@@ -653,4 +659,5 @@ private:
 private:
 	friend class MwtExplorer<Ctx>;
 };
-}
+} // End namespace MultiWorldTestingCpp
+/*! @} End of Doxygen Groups*/
\ No newline at end of file
diff --git a/explore/static/utility.h b/explore/static/utility.h
index dce5d67f..02a9152b 100644
--- a/explore/static/utility.h
+++ b/explore/static/utility.h
@@ -32,6 +32,11 @@ typedef unsigned char    byte;
 #include <stdint.h>

 #include <math.h>

 

+/*!

+*  \addtogroup MultiWorldTestingCpp

+*  @{

+*/

+

 MWT_NAMESPACE {

 

 //

@@ -278,3 +283,4 @@ namespace PRG {
 	};

 }

 }

+/*! @} End of Doxygen Groups*/
\ No newline at end of file