Selaa lähdekoodia

Documentation updates

submodule
Trevor Irons 6 vuotta sitten
vanhempi
commit
8d634ec851

+ 12
- 2
CMakeLists.txt Näytä tiedosto

@@ -220,7 +220,7 @@ endif()
220 220
 
221 221
 set(LEMMA_VERSION_MAJOR "0")
222 222
 set(LEMMA_VERSION_MINOR "1")
223
-set(LEMMA_VERSION_PATCH "1")
223
+set(LEMMA_VERSION_PATCH "2")
224 224
 set(LEMMA_VERSION "\"${LEMMA_VERSION_MAJOR}.${LEMMA_VERSION_MINOR}.${LEMMA_VERSION_PATCH}\"")
225 225
 set(LEMMA_VERSION_NOQUOTES "${LEMMA_VERSION_MAJOR}.${LEMMA_VERSION_MINOR}.${LEMMA_VERSION_PATCH}")
226 226
 
@@ -249,12 +249,21 @@ endif()
249 249
 add_subdirectory (Modules) 
250 250
 
251 251
 ########################################################################
252
-# add a target to generate API documentation with Doxygen
252
+# add a target to generate API documentation with Doxyfile.in 
253 253
 # ALL make documentation build by default if possible
254 254
 find_package(Doxygen)
255 255
 	if(DOXYGEN_FOUND)
256 256
 	option( LEMMA_BUILD_DOCUMENTATION  "Build Doxygen man pages" OFF )
257 257
 	if (LEMMA_BUILD_DOCUMENTATION)
258
+
259
+# Custom header and footer option, enable in Doxygen 
260
+#	file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/Documentation/header.html
261
+#        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/Documentation/header.html
262
+#	)
263
+#	file(COPY ${CMAKE_CURRENT_SOURCE_DIR}/Documentation/footer.html
264
+#        DESTINATION ${CMAKE_CURRENT_BINARY_DIR}/Documentation/footer.html
265
+#	)
266
+
258 267
 	configure_file(${CMAKE_CURRENT_SOURCE_DIR}/Documentation/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Documentation/Doxyfile @ONLY)
259 268
 		add_custom_target(doc
260 269
 			ALL
@@ -262,6 +271,7 @@ find_package(Doxygen)
262 271
 			WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
263 272
 			COMMENT "Generating API documentation with Doxygen" VERBATIM
264 273
 		)
274
+
265 275
 	endif (LEMMA_BUILD_DOCUMENTATION)
266 276
 	endif(DOXYGEN_FOUND)
267 277
 

+ 4
- 4
Documentation/Doxyfile.in Näytä tiedosto

@@ -803,13 +803,13 @@ HTML_FILE_EXTENSION    = .html
803 803
 # each generated HTML page. If it is left blank doxygen will generate a
804 804
 # standard header.
805 805
 
806
-HTML_HEADER            =
806
+#HTML_HEADER            = #Documentation/header.html
807 807
 
808 808
 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
809 809
 # each generated HTML page. If it is left blank doxygen will generate a
810 810
 # standard footer.
811 811
 
812
-HTML_FOOTER            =
812
+#HTML_FOOTER            = Documentation/footer.html 
813 813
 
814 814
 # If the HTML_TIMESTAMP tag is set to YES then the generated HTML
815 815
 # documentation will contain the timesstamp.
@@ -1025,7 +1025,7 @@ ECLIPSE_DOC_ID         = org.doxygen.Project
1025 1025
 # top of each HTML page. The value NO (the default) enables the index and
1026 1026
 # the value YES disables it.
1027 1027
 
1028
-DISABLE_INDEX          = NO
1028
+DISABLE_INDEX          = YES
1029 1029
 
1030 1030
 # This tag can be used to set the number of enum values (range [1..20])
1031 1031
 # that doxygen will group on one line in the generated HTML documentation.
@@ -1040,7 +1040,7 @@ ENUM_VALUES_PER_LINE   = 4
1040 1040
 # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser).
1041 1041
 # Windows users are probably better off using the HTML help feature.
1042 1042
 
1043
-GENERATE_TREEVIEW      = NONE
1043
+GENERATE_TREEVIEW      = YES
1044 1044
 
1045 1045
 # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories,
1046 1046
 # and Class Hierarchy pages using a tree view instead of an ordered list.

+ 0
- 0
Documentation/footer.html Näytä tiedosto


+ 0
- 0
Documentation/header.html Näytä tiedosto


+ 1
- 0
Modules/FDEM1D/examples/CMakeLists.txt Näytä tiedosto

@@ -18,4 +18,5 @@ INSTALL_TARGETS( "/share/FEM1D/"
18 18
 	FieldPoints
19 19
 	PolygonalWireAntenna
20 20
 	EMDipEarth1D
21
+    CircularLoop
21 22
 )

Loading…
Peruuta
Tallenna