Add support for images in Doxygen, and add two of them.

nkoenig · Mar 6, 2012 · 2198da4 · 2198da4
1 parent 58c978b
commit 2198da4
Show file tree

Hide file tree

Showing 8 changed files with 11 additions and 4 deletions.
diff --git a/Doxyfile.in b/Doxyfile.in
@@ -665,7 +665,10 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see
 # the \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = "@PROJECT_SOURCE_DIR@/doc/images" \
+                         "@PROJECT_SOURCE_DIR@/Simbody/doc/images" \
+                         "@PROJECT_SOURCE_DIR@/SimTKmath/doc/images" \
+                         "@PROJECT_SOURCE_DIR@/SimTKcommon/doc/images"
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program

diff --git a/SimTKcommon/Doxyfile.in b/SimTKcommon/Doxyfile.in
@@ -644,7 +644,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see 
 # the \image command).
 
-IMAGE_PATH             = 
+IMAGE_PATH             = "@PROJECT_SOURCE_DIR@/doc/images"
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
 # invoke to filter for each input file. Doxygen will invoke the filter program 

diff --git a/SimTKmath/Doxyfile.in b/SimTKmath/Doxyfile.in
@@ -644,7 +644,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see 
 # the \image command).
 
-IMAGE_PATH             = 
+IMAGE_PATH             = "@PROJECT_SOURCE_DIR@/doc/images"
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should 
 # invoke to filter for each input file. Doxygen will invoke the filter program 

diff --git a/SimTKmath/Geometry/include/simmath/internal/BicubicSurface.h b/SimTKmath/Geometry/include/simmath/internal/BicubicSurface.h
@@ -57,6 +57,8 @@ class BicubicFunction if you need to satisfy the SimTK::Function interface.
 A single BicubicSurface can be shared among multiple accessors and threads
 once constructed.
 
+@image html BicubicSurface1.png "A single-patch bicubic surface"
+
 A bicubic surface interpolation is used to approximate the function
 between the sample points. That is desirable for simulation use because it is 
 continuous up to the second derivative, providing smoothly varying first 

diff --git a/SimTKmath/doc/images/BicubicSurface1.png b/SimTKmath/doc/images/BicubicSurface1.png
diff --git a/Simbody/Doxyfile.in b/Simbody/Doxyfile.in
@@ -664,7 +664,7 @@ EXAMPLE_RECURSIVE      = NO
 # directories that contain image that are included in the documentation (see
 # the \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = "@PROJECT_SOURCE_DIR@/doc/images"
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program

diff --git a/SimbodyMainpage.h b/SimbodyMainpage.h
@@ -27,6 +27,8 @@ specific questions, use the Simbody help forum under the "Advanced" tab.
 You can also file bug reports and make feature requests using the tools 
 provided there.
 
+@image html isaac.png "Our hero, Sir Isaac Newton"
+
 <h2>What is Simbody?</h2>
 Simbody is a high-performance, industrial-grade open source C++ library 
 providing sophisticated treatment of articulated multibody systems with special

diff --git a/doc/images/isaac.png b/doc/images/isaac.png