From fff66ad3f6fa69d6b8951b1c4e33ec1403394325 Mon Sep 17 00:00:00 2001 From: Josh Klontz Date: Thu, 9 May 2013 14:29:44 -0400 Subject: [PATCH] fixed up documentation generation --- openbr/openbr.h | 1 + openbr/openbr_export.cpp | 2 +- openbr/openbr_plugin.cpp | 3 +-- openbr/openbr_plugin.h | 5 +++-- openbr/plugins/quality.cpp | 5 +++-- share/openbr/Doxyfile.in | 23 ++++++++++++----------- 6 files changed, 21 insertions(+), 18 deletions(-) diff --git a/openbr/openbr.h b/openbr/openbr.h index 0ba39bd..0f9bb0f 100644 --- a/openbr/openbr.h +++ b/openbr/openbr.h @@ -300,6 +300,7 @@ BR_EXPORT float br_progress(); * * Used by the \ref cli to implement \c -daemon, generally not useful otherwise. * Guaranteed to return at least one argument. + * \param pipe Pipe name * \param[out] argc argument count * \param[out] argv argument list * \note \ref managed_return_value diff --git a/openbr/openbr_export.cpp b/openbr/openbr_export.cpp index 3f3a9cc..ed12151 100644 --- a/openbr/openbr_export.cpp +++ b/openbr/openbr_export.cpp @@ -101,7 +101,7 @@ $ br -help * $ nmake install * $ nmake clean * \endcode -* -# Download Qt 5.0.1 and unzip. + * -# Download Qt 5.0.1 and unzip. * -# Install Perl/Python/Ruby dependencies as explained in the "Windows" section of "README". Make sure they are added to "path" when given the option during installation. * -# Download Direct X Software Developement Kit and install. * -# From the VS2012 x64 Cross Tools Command Prompt: diff --git a/openbr/openbr_plugin.cpp b/openbr/openbr_plugin.cpp index 6995115..b2877d5 100644 --- a/openbr/openbr_plugin.cpp +++ b/openbr/openbr_plugin.cpp @@ -25,13 +25,12 @@ #include #include #include -#include -#include #ifndef BR_EMBEDDED #include #endif +#include "openbr_plugin.h" #include "version.h" #include "core/bee.h" #include "core/common.h" diff --git a/openbr/openbr_plugin.h b/openbr/openbr_plugin.h index 531493d..53b2026 100644 --- a/openbr/openbr_plugin.h +++ b/openbr/openbr_plugin.h @@ -96,7 +96,7 @@ namespace br * * \b Example:
* Note the symmetry between \c BR_PROPERTY and \c Q_PROPERTY. - * \snippet sdk/plugins/misc.cpp example_transform + * \snippet openbr/plugins/misc.cpp example_transform */ #define BR_PROPERTY(TYPE,NAME,DEFAULT) \ TYPE NAME; \ @@ -715,6 +715,7 @@ public: * By default share/openbr/openbr.bib will be searched for relative to: * -# The working directory * -# The executable's location + * \param use_gui Create a QApplication instead of a QCoreApplication. * \note Tiggers \em abort() on failure to locate share/openbr/openbr.bib. * \note Qt users should instead call this after initializing QApplication. * \see finalize @@ -858,7 +859,7 @@ const FactoryInstance<_Abstraction,_Implementation> FactoryInstance<_Abstraction * * \b Example:
* Note the use of \c Q_OBJECT at the beginning of the class declaration and \c BR_REGISTER after the class declaration. - * \snippet sdk/plugins/misc.cpp example_transform + * \snippet openbr/plugins/misc.cpp example_transform */ #define BR_REGISTER(ABSTRACTION,IMPLEMENTATION) \ template class \ diff --git a/openbr/plugins/quality.cpp b/openbr/plugins/quality.cpp index 6d34ff4..5ebb34e 100644 --- a/openbr/plugins/quality.cpp +++ b/openbr/plugins/quality.cpp @@ -181,8 +181,9 @@ class MatchProbabilityDistance : public Distance float compare(const Template &target, const Template &query) const { float rawScore = distance->compare(target, query); - if (rawScore == -std::numeric_limits::max()) return rawScore; - return mp(rawScore, gaussian); + return -log(rawScore+1); + //if (rawScore == -std::numeric_limits::max()) return rawScore; + //return mp(rawScore, gaussian); } void store(QDataStream &stream) const diff --git a/share/openbr/Doxyfile.in b/share/openbr/Doxyfile.in index b371487..34c352c 100644 --- a/share/openbr/Doxyfile.in +++ b/share/openbr/Doxyfile.in @@ -130,7 +130,7 @@ FULL_PATH_NAMES = YES # relative paths, which will be relative from the directory where doxygen is # started. -STRIP_FROM_PATH = ${CMAKE_CURRENT_SOURCE_DIR} +STRIP_FROM_PATH = ${CMAKE_SOURCE_DIR} # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells @@ -661,9 +661,8 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = ${CMAKE_CURRENT_SOURCE_DIR}/sdk \ - ${CMAKE_CURRENT_SOURCE_DIR}/app/br \ - ${CMAKE_CURRENT_SOURCE_DIR}/app/examples +INPUT = ${CMAKE_SOURCE_DIR}/app \ + ${CMAKE_SOURCE_DIR}/openbr # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -681,8 +680,7 @@ INPUT_ENCODING = UTF-8 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py # *.f90 *.f *.for *.vhd *.vhdl -FILE_PATTERNS = *.h \ - *.cpp +FILE_PATTERNS = *.h *.cpp # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. @@ -710,7 +708,9 @@ EXCLUDE_SYMLINKS = YES # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* -EXCLUDE_PATTERNS = */core/* +EXCLUDE_PATTERNS = */core/*.cpp \ + */gui/*.cpp \ + */icons/* # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -733,7 +733,8 @@ EXCLUDE_SYMBOLS = br::FactoryInstance \ # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = ${CMAKE_CURRENT_SOURCE_DIR}/ +EXAMPLE_PATH = ${CMAKE_SOURCE_DIR}/app \ + ${CMAKE_SOURCE_DIR}/openbr # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp @@ -1245,13 +1246,13 @@ SERVER_BASED_SEARCH = NO # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. -LATEX_OUTPUT = latex +LATEX_OUTPUT = # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. @@ -1538,7 +1539,7 @@ INCLUDE_FILE_PATTERNS = # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = BR_EXPORT= +PREDEFINED = BR_EXPORT= __cplusplus # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. -- libgit2 0.21.4