Skip to content

Commit

Permalink
doxygen fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
jklontz committed Oct 1, 2014
1 parent 614fdb7 commit cc364a8
Show file tree
Hide file tree
Showing 5 changed files with 1,368 additions and 954 deletions.
3 changes: 0 additions & 3 deletions openbr/core/core.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -548,13 +548,11 @@ struct AlgorithmCore
return;
}

//! [Parsing the algorithm description]
const bool compareTransform = description.contains('!');
QStringList words = QtUtils::parse(description, compareTransform ? '!' : ':');

if ((words.size() < 1) || (words.size() > 2)) qFatal("Invalid algorithm format.");

//! [Creating the template generation and comparison methods]
transform = QSharedPointer<Transform>(Transform::make(words[0], NULL));
simplifyTransform();

Expand All @@ -567,7 +565,6 @@ struct AlgorithmCore
else
comparison = QSharedPointer<Transform>(Transform::make(words[1], NULL));
}
//! [Creating the template generation and comparison methods]
}
};

Expand Down
9 changes: 3 additions & 6 deletions openbr/openbr_export.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

/*!
* \mainpage
* \page overview Overview
* \section overview Overview
* OpenBR \cite klontz2013open is a framework for investigating new modalities, improving existing algorithms, interfacing with commercial systems, measuring recognition performance, and deploying automated biometric systems.
* The project is designed to facilitate rapid algorithm prototyping, and features a mature core framework, flexible plugin system, and support for open and closed source development.
* Off-the-shelf algorithms are also available for specific modalities including \ref cpp_face_recognition, \ref cpp_age_estimation, and \ref cpp_gender_estimation.
Expand Down Expand Up @@ -433,11 +433,8 @@
*
* Let's look at some of the important parts of the code base that make this possible!
*
* In <tt>AlgorithmCore::init()</tt> in <tt>openbr/core/core.cpp</tt> you can see the code for splitting the algorithm description at the colon:
* \snippet openbr/core/core.cpp Parsing the algorithm description
*
* Shortly thereafter in this function we <i>make</i> the template generation and comparison methods:
* \snippet openbr/core/core.cpp Creating the template generation and comparison methods
* In <tt>AlgorithmCore::init()</tt> in <tt>openbr/core/core.cpp</tt> you can see the code for splitting the algorithm description at the colon.
* Shortly thereafter in this function we <i>make</i> the template generation and comparison methods.
* These make calls are defined in the public \ref cpp_plugin_sdk and can also be called from end user code.
*
* Below we discuss some of the source code for \ref br::Transform::make in <tt>openbr/openbr_plugin.cpp</tt>.
Expand Down
2 changes: 1 addition & 1 deletion openbr/openbr_plugin.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ QString File::hash() const
return QtUtils::shortTextHash(flat());
}

void File::append(const QMap<QString,QVariant> &metadata)
void File::append(const QVariantMap &metadata)
{
foreach (const QString &key, metadata.keys())
set(key, metadata[key]);
Expand Down
2 changes: 1 addition & 1 deletion openbr/plugins/draw.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,7 @@ BR_REGISTER(Transform, DrawSegmentation)
/*!
* \ingroup transforms
* \brief Write all mats to disk as images.
* \author Brendan Klare \bklare
* \author Brendan Klare \cite bklare
*/
class WriteImageTransform : public TimeVaryingTransform
{
Expand Down
Loading

0 comments on commit cc364a8

Please sign in to comment.