Cleaning up documentation a bit

CMakeLists.txt

@@ -5,46 +5,49 @@ set(EMSCHUR3D_VERSION_PATCH "1")
 set(EMSCHUR3D_VERSION "\"${EMSCHUR3D_VERSION_MAJOR}.${EMSCHUR3D_VERSION_MINOR}.${EMSCHUR3D_VERSION_PATCH}\"")
 set(EMSCHUR3D_VERSION_NOQUOTES "${EMSCHUR3D_VERSION_MAJOR}.${EMSCHUR3D_VERSION_MINOR}.${EMSCHUR3D_VERSION_PATCH}")
 
-configure_file (
-	"${CMAKE_CURRENT_SOURCE_DIR}/config/EMSchur3DConfig.h.in"
-	"${PROJECT_BINARY_DIR}/include/EMSchur3DConfig.h"
-)
-install ( FILES  ${PROJECT_BINARY_DIR}/include/EMSchur3DConfig.h   DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/ )
-
-add_subdirectory("src")
-add_library( emschur3d ${EMSCHUR3DSOURCE} )  
-target_include_directories( emschur3d PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/include" )
-
-set_target_properties(emschur3d PROPERTIES 
-	VERSION  "${EMSCHUR3D_VERSION_NOQUOTES}"
-	SOVERSION "${EMSCHUR3D_VERSION_MAJOR}.${LEMMA_VERSION_MINOR}"
-	PROJECT_LABEL "EMSCHUR3D ${LABEL_SUFFIX}"
-    CXX_STANDARD_14
-    CXX_STANDARD_REQUIRED_ON
-)
-
-# Linking
-target_link_libraries(emschur3d "lemmacore" "fdem1d" )
-
-# Linking
 if ( LEMMA_VTK6_SUPPORT OR LEMMA_VTK7_SUPPORT ) 
+
+	configure_file (
+		"${CMAKE_CURRENT_SOURCE_DIR}/config/EMSchur3DConfig.h.in"
+		"${PROJECT_BINARY_DIR}/include/EMSchur3DConfig.h"
+	)
+	install ( FILES  ${PROJECT_BINARY_DIR}/include/EMSchur3DConfig.h   DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/ )
+
+	add_subdirectory("src")
+	add_library( emschur3d ${EMSCHUR3DSOURCE} )  
+	target_include_directories( emschur3d PUBLIC "${CMAKE_CURRENT_SOURCE_DIR}/include" )
+
+	set_target_properties(emschur3d PROPERTIES 
+		VERSION  "${EMSCHUR3D_VERSION_NOQUOTES}"
+		SOVERSION "${EMSCHUR3D_VERSION_MAJOR}.${LEMMA_VERSION_MINOR}"
+		PROJECT_LABEL "EMSCHUR3D ${LABEL_SUFFIX}"
+    	CXX_STANDARD_14
+    	CXX_STANDARD_REQUIRED_ON
+	)
+
+	# Linking
+	target_link_libraries(emschur3d "lemmacore" "fdem1d" )
+
+	# Linking
 	target_link_libraries(emschur3d ${VTK_LIBRARIES})
-endif()
 
-# Testing
-if (LEMMA_ENABLE_TESTING)
-	add_subdirectory(testing)
-endif()
 
-# Install
-install ( TARGETS emschur3d DESTINATION ${CMAKE_INSTALL_PREFIX}/lib )
-install ( FILES include/EMSchur3D  DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma ) 
-install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma  FILES_MATCHING PATTERN "*.h")
+	# Testing
+	if (LEMMA_ENABLE_TESTING)
+		add_subdirectory(testing)
+	endif()
+
+	# Install
+	install ( TARGETS emschur3d DESTINATION ${CMAKE_INSTALL_PREFIX}/lib )
+	install ( FILES include/EMSchur3D  DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma ) 
+	install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma  FILES_MATCHING PATTERN "*.h")
+
+	#install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/  FILES_MATCHING PATTERN "FDEM1D")
+	#install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/FDEM1D  FILES_MATCHING PATTERN "*.h")
 
-#install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/  FILES_MATCHING PATTERN "FDEM1D")
-#install ( DIRECTORY include/ DESTINATION ${CMAKE_INSTALL_PREFIX}/include/Lemma/FDEM1D  FILES_MATCHING PATTERN "*.h")
+	# Examples
+	if (	LEMMA_BUILD_EXAMPLES)
+		add_subdirectory(examples)
+	endif()
 
-# Examples
-if (LEMMA_BUILD_EXAMPLES)
-	add_subdirectory(examples)
 endif()

EMSchur3D.dox

@@ -0,0 +1,15 @@
+/**
+ * @file
+ * @date      09/15/2016 04:28:16 PM
+ * @author    Trevor Irons (ti)
+ * @email     tirons@egi.utah.edu
+ * @copyright Copyright (c) 2016, University of Utah
+ * @copyright Copyright (c) 2016, Lemma Software, LLC
+ */
+
+/**
+    \defgroup EMSchur3D EMSchur3D
+    @brief    Provides 3D solution to Maxwell's equations.
+    @details  This is provided using a finite difference scheme.
+ */
+

include/EMSchur3DBase.h

@@ -77,17 +77,10 @@
 
 namespace Lemma {
 
-/**
- \defgroup EMSchur3DBase EMSchur3DBase
-  Provides 3D solution to Maxwell's equations.
- */
-
 enum SOLVER{ SPARSELU, SimplicialLLT, SimplicialLDLT, BiCGStab, SparseQR };
 
-
 /**
-  @class EMSchur3DBase
-  \ingroup EMSchur3DBase
+  \ingroup EMSchur3D
   \brief Provides a 3D solution to Maxwell's equations.
   \details 3D finite difference solution to maxwells equations
             using a SCHUR decomposition on a staggered grid.