Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Twiddled the Doxygen configuration a bit, added a

"make doc" master target that builds both the 
Doxygen documentation and the Workbook, and updated 
the README file accordingly.
  • Loading branch information...
commit 2353c64acc46c22fe805d1cfb6135b701833c124 1 parent ed34ea1
Matthew Hancher authored
Showing with 12 additions and 10 deletions.
  1. +3 −1 Makefile.am
  2. +3 −2 README
  3. +6 −7 src/{vw → }/Doxyfile
View
4 Makefile.am
@@ -71,7 +71,9 @@ workbook: all
cd docs/workbook && $(MAKE) $(AM_MAKEFLAGS) workbook.pdf
doxygen:
- cd src/vw && doxygen
+ cd src && doxygen
+
+doc: workbook doxygen
########################################################################
# general
View
5 README
@@ -289,13 +289,14 @@ well as documentation for each of the high level Vision Workbench
modules. A copy of this document in PDF format should be available
from wherever you obtained this package. The original source for this
document can be found in "docs/workbook" and it can be built by
-running "make doc". This operation requires the latex typesetting
+running "make workbook". This operation requires the latex typesetting
package.
Auto-generated API documentation is also available if you have a
working installation of Doxygen and latex. Running "make doxygen" at
the top level of the source tree will generate documentation in the
-"docs/api" directory.
+"docs/api" directory. Running "make doc" will automatically generate
+both the Workbook and the Doxygen documentation.
************************************************************************
6. CONTACTS & CREDITS
View
13 src/vw/Doxyfile → src/Doxyfile
@@ -5,7 +5,7 @@
#---------------------------------------------------------------------------
PROJECT_NAME = "Vision Workbench"
PROJECT_NUMBER = "1.0"
-OUTPUT_DIRECTORY = ../../docs
+OUTPUT_DIRECTORY = ../docs
CREATE_SUBDIRS = YES
OUTPUT_LANGUAGE = English
USE_WINDOWS_ENCODING = NO
@@ -24,7 +24,7 @@ ABBREVIATE_BRIEF = "The $name class" \
the
ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = YES
-FULL_PATH_NAMES = NO
+FULL_PATH_NAMES = YES
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
@@ -82,14 +82,14 @@ WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
-INPUT = . Core Image Math FileIO Camera HDR Mosaic Cartography
+INPUT = vw vw/Core vw/Image vw/Math vw/FileIO vw/Camera vw/HDR vw/Mosaic vw/Cartography
FILE_PATTERNS = *.h
RECURSIVE = NO
EXCLUDE =
EXCLUDE_SYMLINKS = YES
EXCLUDE_PATTERNS =
-EXAMPLE_PATH = tests
-EXAMPLE_PATTERNS = Test*
+EXAMPLE_PATH = vw/tests vw/Core/tests vw/Image/tests vw/Math/tests vw/FileIO/tests vw/Camera/tests vw/HDR/tests vw/Mosaic/tests vw/Cartography/tests
+EXAMPLE_PATTERNS = Test*.h
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
@@ -115,7 +115,7 @@ IGNORE_PREFIX =
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
-HTML_OUTPUT = api
+HTML_OUTPUT = doxygen
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
@@ -218,7 +218,6 @@ CALL_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
-DOT_PATH = /Applications/Graphviz.app/Contents/MacOS
DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 1024
MAX_DOT_GRAPH_HEIGHT = 1024
Please sign in to comment.
Something went wrong with that request. Please try again.