Permalink
Browse files

Added Doxygen documentation generation back in (via 'make doxygen').

Made a few tweaks to the documentation in various header files to
squash doxygen warnings.

Updated README to reflect changes.
  • Loading branch information...
1 parent 4a8ff53 commit c7cdd00279c7fce32738502bf1f55f6e87d8c54e @broxtronix broxtronix committed Dec 4, 2006
View
@@ -218,6 +218,24 @@ documentation for details.
| OpenEXR | FileIO (opt.) | http://www.openexr.com/ |
+---------+--------------------+------------------------------------+
+In addition, the some Vision Workbench modules require other, lower
+level modules to be built. The internal Vision Workbench dependency
+table appears below.
+
++------+--------+-------------+
+| HDR | Mosaic | Cartography | Application-specific Toolkits
++------+--------+-------------+
++---------------+-------------+
+| FileIO | Camera | High-level Primatives
++---------------+-------------+
++---------------+-------------+
+| Image | Math | Low-level image processing/Linear Algrebra
++---------------+-------------+
++-----------------------------+
+| Core | Basic Programming Infrastructure
++-----------------------------+
+
+
B. Building and Installing
Once you have obtained and installed all of the prerequisite software
@@ -264,14 +282,20 @@ of the tools.
************************************************************************
5. DOCUMENTATION
-The primary source of documentation is the Vision Workbook, which is
-provided in source form along with this distribution. It includes a
-user's guide for each of the Vision Workbench modules, as well as
-automatically-generated reference manuals. A copy of this document
-in PDF format should be available from wherever you obtained this
-package. Alternatively, you may build an up-to-date copy of the
-book from the sources by running "make doc". This requires a working
-installation of both LaTeX and Doxygen.
+The primary source of documentation is the Vision Workbook, which is
+provided in source form along with this distribution. It includes a
+gentle introduction to using the core image processing routines, as
+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
+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.
************************************************************************
6. CONTACTS & CREDITS
@@ -5,7 +5,7 @@ \chapter{Advanced Topics}\label{ch:advanced-topics}
\section{Working with Shallow Views}\label{sec:advanced.shallow}
-\section{Efficient Algorithms and {\tt pixel\char`\_iterator}}
+\section{Efficient Algorithms and {\tt pixel\char`\_accessor}}
\section{Rasterization, Efficiency, and Tiled Computation}
@@ -8,6 +8,7 @@ \chapter{Getting Started}\label{ch:gettingstarted}
then skip ahead to Chapter~\ref{ch:workingwithimages}.
\section{Obtaining the Vision Workbench}
+\label{sec:obtaining-vw}
Most likely if you are reading this document then you already know
where to obtain a copy of the Vision Workbench sources if you haven't
@@ -28,6 +29,7 @@ \section{Obtaining the Vision Workbench}
\begin{tabular}{|l|l|l|} \hline
Name & Used By & Source \\ \hline \hline
Boost & All & \verb#http://www.boost.org/# \\ \hline
+Boost & Portions of Math, HDR & See note in Section \ref{sec:obtaining-vw} \\ \hline
PNG & FileIO (opt.) & \verb#http://www.libpng.org/# \\ \hline
JPEG & FileIO (opt.) & \verb#http://www.ijg.org/# \\ \hline
TIFF & FileIO (opt.) & \verb#http://www.libtiff.org/# \\ \hline
@@ -54,6 +56,28 @@ \section{Obtaining the Vision Workbench}
rebuild the Vision Workbench with support for additional features
later if you discover that you need them.
+One dependency that is worth discussing briefly is LAPACK, which
+provides Vision Workbench with a computational linear algebra back
+end. LAPACK is a comprehensive and widely used linear algebra support
+library in the public domain. LAPACK also require the Basic Linear
+Algebra Subroutines (BLAS) library, which is usually bundled with
+LAPACK.
+
+The basic matrix and vector algebra in the Math module does not depend
+on LAPACK and BLAS, however the routines in
+\verb#<vw/Math/LinearAlgebra.h># will only be built if LAPACK is
+detected by the build system. For your convenience, we provide a
+stand-alone LAPACK and BLAS distribution on the Vision Workbench web
+page. This distribution has been tested with the Vision Workbench, so
+we recommend its use if you are installing LAPACK for the first time.
+However, other versions of LAPACK and BLAS that come pre-installed on
+your system will probably work just as well. In particular, Mac OS X
+users {\em do not} need to install LAPACK; machine optimized linear
+algebra support is provided by Apple's \verb#veclib# framework on Mac
+OS X. Remember to add the \verb#-framework veclib# flag when linking
+your application against the Vision Workbench if you are using the
+functions in \verb#<vw/Math/LinearAlgebra.h># on the mac platform.
+
\section{Building the Vision Workbench}
If you are using a UNIX-like platform such as Linux or Mac OS it is
@@ -21,7 +21,7 @@
//
// __END_LICENSE__
-/// \file CAHV.h
+/// \file CAHVModel.h
///
/// This file contains the CAHV pinhole camera model.
///
@@ -21,7 +21,7 @@
//
// __END_LICENSE__
-/// \file CAHVOR.h
+/// \file CAHVORModel.h
///
/// This file contains the CAHVOR pinhole camera model. This camera
/// model is a refinement of the \ref CAHVModel: it adds extra terms
@@ -21,7 +21,7 @@
//
// __END_LICENSE__
-/// \file CAHV.h
+/// \file FisheyeModel.h
///
/// This file contains the fisheye camera model.
///
@@ -21,7 +21,7 @@
//
// __END_LICENSE__
-/// \file LinearPusbroomModel.h
+/// \file LinearPushbroomModel.h
///
/// Linear pushbroom camera model object.
///
@@ -21,7 +21,7 @@
//
// __END_LICENSE__
-/// \file OrbitingPusbroomModel.h
+/// \file OrbitingPushbroomModel.h
///
/// Orbiting pushbroom camera model object.
///
View
@@ -0,0 +1,233 @@
+# Doxyfile 1.4.6
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME = "Vision Workbench"
+PROJECT_NUMBER = "1.0"
+OUTPUT_DIRECTORY = ../../docs
+CREATE_SUBDIRS = YES
+OUTPUT_LANGUAGE = English
+USE_WINDOWS_ENCODING = NO
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = YES
+ABBREVIATE_BRIEF = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+ALWAYS_DETAILED_SEC = YES
+INLINE_INHERITED_MEMB = YES
+FULL_PATH_NAMES = NO
+STRIP_FROM_PATH =
+STRIP_FROM_INC_PATH =
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = YES
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP = YES
+INHERIT_DOCS = YES
+SEPARATE_MEMBER_PAGES = NO
+TAB_SIZE = 4
+ALIASES =
+OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_JAVA = NO
+BUILTIN_STL_SUPPORT = YES
+DISTRIBUTE_GROUP_DOC = NO
+SUBGROUPING = YES
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = NO
+EXTRACT_PRIVATE = NO
+EXTRACT_STATIC = NO
+EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_METHODS = NO
+HIDE_UNDOC_MEMBERS = YES
+HIDE_UNDOC_CLASSES = YES
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = NO
+CASE_SENSE_NAMES = YES
+HIDE_SCOPE_NAMES = NO
+SHOW_INCLUDE_FILES = NO
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = NO
+SORT_BRIEF_DOCS = NO
+SORT_BY_SCOPE_NAME = NO
+GENERATE_TODOLIST = YES
+GENERATE_TESTLIST = YES
+GENERATE_BUGLIST = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 30
+SHOW_USED_FILES = YES
+SHOW_DIRECTORIES = YES
+FILE_VERSION_FILTER =
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = NO
+WARN_IF_DOC_ERROR = YES
+WARN_NO_PARAMDOC = NO
+WARN_FORMAT = "$file:$line: $text"
+WARN_LOGFILE =
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = . Core Image Math FileIO Camera HDR Mosaic Cartography
+FILE_PATTERNS = *.h
+RECURSIVE = NO
+EXCLUDE =
+EXCLUDE_SYMLINKS = YES
+EXCLUDE_PATTERNS =
+EXAMPLE_PATH = tests
+EXAMPLE_PATTERNS = Test*
+EXAMPLE_RECURSIVE = NO
+IMAGE_PATH =
+INPUT_FILTER =
+FILTER_PATTERNS =
+FILTER_SOURCE_FILES = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = YES
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = NO
+REFERENCED_BY_RELATION = YES
+REFERENCES_RELATION = YES
+USE_HTAGS = NO
+VERBATIM_HEADERS = YES
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = YES
+COLS_IN_ALPHA_INDEX = 5
+IGNORE_PREFIX =
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = api
+HTML_FILE_EXTENSION = .html
+HTML_HEADER =
+HTML_FOOTER =
+HTML_STYLESHEET =
+HTML_ALIGN_MEMBERS = YES
+GENERATE_HTMLHELP = NO
+CHM_FILE =
+HHC_LOCATION =
+GENERATE_CHI = NO
+BINARY_TOC = NO
+TOC_EXPAND = NO
+DISABLE_INDEX = NO
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = NO
+TREEVIEW_WIDTH = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = letter
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = YES
+USE_PDFLATEX = YES
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = NO
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = NO
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED =
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE =
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = YES
+PERL_PATH = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = NO
+HIDE_UNDOC_RELATIONS = YES
+HAVE_DOT = NO
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = YES
+GROUP_GRAPHS = YES
+UML_LOOK = NO
+TEMPLATE_RELATIONS = NO
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = YES
+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
+MAX_DOT_GRAPH_DEPTH = 1000
+DOT_TRANSPARENT = NO
+DOT_MULTI_TARGETS = NO
+GENERATE_LEGEND = YES
+DOT_CLEANUP = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+SEARCHENGINE = YES
@@ -35,7 +35,10 @@
#include <vw/FileIO/DiskImageResource.h>
// Forward-declare the Imf::InputFile class
+
+/// \cond INTERNAL
namespace Imf { class InputFile; }
+/// \endcond
namespace vw {
Oops, something went wrong. Retry.

0 comments on commit c7cdd00

Please sign in to comment.