Peter M. Groen / openbr

Commit fff66ad3f6fa69d6b8951b1c4e33ec1403394325

Authored by Josh Klontz
1 parent 90051d67

fixed up documentation generation

Inline Side-by-side
Showing 6 changed files with 21 additions and 18 deletions
openbr/openbr.h
  View file @fff66ad
... ... @@ -300,6 +300,7 @@ BR_EXPORT float br_progress();
300 300 *
301 301 * Used by the \ref cli to implement \c -daemon, generally not useful otherwise.
302 302 * Guaranteed to return at least one argument.
  303 + * \param pipe Pipe name
303 304 * \param[out] argc argument count
304 305 * \param[out] argv argument list
305 306 * \note \ref managed_return_value
... ...
openbr/openbr_export.cpp
  View file @fff66ad
... ... @@ -101,7 +101,7 @@ $ br -help
101 101 * $ nmake install
102 102 * $ nmake clean
103 103 * \endcode
104   -* -# <a href="http://releases.qt-project.org/qt5/5.0.1/single/qt-everywhere-opensource-src-5.0.1.zip">Download Qt 5.0.1</a> and unzip.
  104 + * -# <a href="http://releases.qt-project.org/qt5/5.0.1/single/qt-everywhere-opensource-src-5.0.1.zip">Download Qt 5.0.1</a> and unzip.
105 105 * -# 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.
106 106 * -# <a href="http://www.microsoft.com/en-us/download/confirmation.aspx?id=6812">Download Direct X Software Developement Kit</a> and install.
107 107 * -# From the VS2012 x64 Cross Tools Command Prompt:
... ...
openbr/openbr_plugin.cpp
  View file @fff66ad
... ... @@ -25,13 +25,12 @@
25 25 #include <QtConcurrentRun>
26 26 #include <algorithm>
27 27 #include <iostream>
28   -#include <openbr/openbr_plugin.h>
29   -#include <openbr/plugins/openbr_internal.h>
30 28  
31 29 #ifndef BR_EMBEDDED
32 30 #include <QApplication>
33 31 #endif
34 32  
  33 +#include "openbr_plugin.h"
35 34 #include "version.h"
36 35 #include "core/bee.h"
37 36 #include "core/common.h"
... ...
openbr/openbr_plugin.h
  View file @fff66ad
... ... @@ -96,7 +96,7 @@ namespace br
96 96 *
97 97 * \b Example:<br>
98 98 * Note the symmetry between \c BR_PROPERTY and \c Q_PROPERTY.
99   - * \snippet sdk/plugins/misc.cpp example_transform
  99 + * \snippet openbr/plugins/misc.cpp example_transform
100 100 */
101 101 #define BR_PROPERTY(TYPE,NAME,DEFAULT) \
102 102 TYPE NAME; \
... ... @@ -715,6 +715,7 @@ public:
715 715 * By default <tt>share/openbr/openbr.bib</tt> will be searched for relative to:
716 716 * -# The working directory
717 717 * -# The executable's location
  718 + * \param use_gui Create a QApplication instead of a QCoreApplication.
718 719 * \note Tiggers \em abort() on failure to locate <tt>share/openbr/openbr.bib</tt>.
719 720 * \note <a href="http://qt-project.org/">Qt</a> users should instead call this <i>after</i> initializing QApplication.
720 721 * \see finalize
... ... @@ -858,7 +859,7 @@ const FactoryInstance&lt;_Abstraction,_Implementation&gt; FactoryInstance&lt;_Abstraction
858 859 *
859 860 * \b Example:<br>
860 861 * Note the use of \c Q_OBJECT at the beginning of the class declaration and \c BR_REGISTER after the class declaration.
861   - * \snippet sdk/plugins/misc.cpp example_transform
  862 + * \snippet openbr/plugins/misc.cpp example_transform
862 863 */
863 864 #define BR_REGISTER(ABSTRACTION,IMPLEMENTATION) \
864 865 template class \
... ...
openbr/plugins/quality.cpp
  View file @fff66ad
... ... @@ -181,8 +181,9 @@ class MatchProbabilityDistance : public Distance
181 181 float compare(const Template &target, const Template &query) const
182 182 {
183 183 float rawScore = distance->compare(target, query);
184   - if (rawScore == -std::numeric_limits<float>::max()) return rawScore;
185   - return mp(rawScore, gaussian);
  184 + return -log(rawScore+1);
  185 + //if (rawScore == -std::numeric_limits<float>::max()) return rawScore;
  186 + //return mp(rawScore, gaussian);
186 187 }
187 188  
188 189 void store(QDataStream &stream) const
... ...
share/openbr/Doxyfile.in
  View file @fff66ad
... ... @@ -130,7 +130,7 @@ FULL_PATH_NAMES = YES
130 130 # relative paths, which will be relative from the directory where doxygen is
131 131 # started.
132 132  
133   -STRIP_FROM_PATH = ${CMAKE_CURRENT_SOURCE_DIR}
  133 +STRIP_FROM_PATH = ${CMAKE_SOURCE_DIR}
134 134  
135 135 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
136 136 # the path mentioned in the documentation of a class, which tells
... ... @@ -661,9 +661,8 @@ WARN_LOGFILE =
661 661 # directories like "/usr/src/myproject". Separate the files or directories
662 662 # with spaces.
663 663  
664   -INPUT = ${CMAKE_CURRENT_SOURCE_DIR}/sdk \
665   - ${CMAKE_CURRENT_SOURCE_DIR}/app/br \
666   - ${CMAKE_CURRENT_SOURCE_DIR}/app/examples
  664 +INPUT = ${CMAKE_SOURCE_DIR}/app \
  665 + ${CMAKE_SOURCE_DIR}/openbr
667 666  
668 667 # This tag can be used to specify the character encoding of the source files
669 668 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
... ... @@ -681,8 +680,7 @@ INPUT_ENCODING = UTF-8
681 680 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
682 681 # *.f90 *.f *.for *.vhd *.vhdl
683 682  
684   -FILE_PATTERNS = *.h \
685   - *.cpp
  683 +FILE_PATTERNS = *.h *.cpp
686 684  
687 685 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
688 686 # should be searched for input files as well. Possible values are YES and NO.
... ... @@ -710,7 +708,9 @@ EXCLUDE_SYMLINKS = YES
710 708 # against the file with absolute path, so to exclude all test directories
711 709 # for example use the pattern */test/*
712 710  
713   -EXCLUDE_PATTERNS = */core/*
  711 +EXCLUDE_PATTERNS = */core/*.cpp \
  712 + */gui/*.cpp \
  713 + */icons/*
714 714  
715 715 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
716 716 # (namespaces, classes, functions, etc.) that should be excluded from the
... ... @@ -733,7 +733,8 @@ EXCLUDE_SYMBOLS = br::FactoryInstance \
733 733 # directories that contain example code fragments that are included (see
734 734 # the \include command).
735 735  
736   -EXAMPLE_PATH = ${CMAKE_CURRENT_SOURCE_DIR}/
  736 +EXAMPLE_PATH = ${CMAKE_SOURCE_DIR}/app \
  737 + ${CMAKE_SOURCE_DIR}/openbr
737 738  
738 739 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
739 740 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
... ... @@ -1245,13 +1246,13 @@ SERVER_BASED_SEARCH = NO
1245 1246 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
1246 1247 # generate Latex output.
1247 1248  
1248   -GENERATE_LATEX = YES
  1249 +GENERATE_LATEX = NO
1249 1250  
1250 1251 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
1251 1252 # If a relative path is entered the value of OUTPUT_DIRECTORY will be
1252 1253 # put in front of it. If left blank `latex' will be used as the default path.
1253 1254  
1254   -LATEX_OUTPUT = latex
  1255 +LATEX_OUTPUT =
1255 1256  
1256 1257 # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
1257 1258 # invoked. If left blank `latex' will be used as the default command name.
... ... @@ -1538,7 +1539,7 @@ INCLUDE_FILE_PATTERNS =
1538 1539 # undefined via #undef or recursively expanded use the := operator
1539 1540 # instead of the = operator.
1540 1541  
1541   -PREDEFINED = BR_EXPORT=
  1542 +PREDEFINED = BR_EXPORT= __cplusplus
1542 1543  
1543 1544 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
1544 1545 # this tag can be used to specify a list of macro names that should be expanded.
... ...