From ddc208933cee2e5bf5bc1c384ab82c75170733db Mon Sep 17 00:00:00 2001 From: Josh Klontz Date: Wed, 26 Dec 2012 13:26:18 -0500 Subject: [PATCH] Documented Context properties --- sdk/openbr_plugin.h | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++------------- share/openbr/Doxyfile.in | 6 +++--- 2 files changed, 61 insertions(+), 16 deletions(-) diff --git a/sdk/openbr_plugin.h b/sdk/openbr_plugin.h index f9c15e8..2ba1cd6 100644 --- a/sdk/openbr_plugin.h +++ b/sdk/openbr_plugin.h @@ -412,31 +412,76 @@ class BR_EXPORT Context : public Object QFile logFile; public: + /*! + * \brief Path to share/openbr/openbr.bib + */ Q_PROPERTY(QString sdkPath READ get_sdkPath WRITE set_sdkPath RESET reset_sdkPath) + BR_PROPERTY(QString, sdkPath, "") + + /*! + * \brief The default algorithm to use when enrolling and comparing templates. + */ Q_PROPERTY(QString algorithm READ get_algorithm WRITE set_algorithm RESET reset_algorithm) + BR_PROPERTY(QString, algorithm, "") + + /*! + * \brief Optional log file to copy stderr to. + */ Q_PROPERTY(QString log READ get_log WRITE set_log RESET reset_log) + BR_PROPERTY(QString, log, "") + + /*! + * \brief Path to use when resolving images specified with relative paths. + */ Q_PROPERTY(QString path READ get_path WRITE set_path RESET reset_path) + BR_PROPERTY(QString, path, "") + + /*! + * \brief The maximum number of templates to process in parallel. + */ Q_PROPERTY(int blockSize READ get_blockSize WRITE set_blockSize RESET reset_blockSize) + BR_PROPERTY(int, blockSize, 1) + + /*! + * \brief The number of threads to use. + */ Q_PROPERTY(int parallelism READ get_parallelism WRITE set_parallelism RESET reset_parallelism) - Q_PROPERTY(bool profiling READ get_profiling WRITE set_profiling RESET reset_profiling) - Q_PROPERTY(bool quiet READ get_quiet WRITE set_quiet RESET reset_quiet) - Q_PROPERTY(bool verbose READ get_verbose WRITE set_verbose RESET reset_verbose) - Q_PROPERTY(QString mostRecentMessage READ get_mostRecentMessage WRITE set_mostRecentMessage RESET reset_mostRecentMessage) - Q_PROPERTY(double currentStep READ get_currentStep WRITE set_currentStep RESET reset_currentStep) - Q_PROPERTY(double totalSteps READ get_totalSteps WRITE set_totalSteps RESET reset_totalSteps) - Q_PROPERTY(bool enrollAll READ get_enrollAll WRITE set_enrollAll RESET reset_enrollAll) - BR_PROPERTY(QString, sdkPath, "") - BR_PROPERTY(QString, algorithm, "") - BR_PROPERTY(QString, log, "") - BR_PROPERTY(QString, path, "") - BR_PROPERTY(int, blockSize, -1) BR_PROPERTY(int, parallelism, 0) - BR_PROPERTY(bool, profiling, false) + + /*! + * \brief If \c true no messages will be sent to the terminal, \c false by default. + */ + Q_PROPERTY(bool quiet READ get_quiet WRITE set_quiet RESET reset_quiet) BR_PROPERTY(bool, quiet, false) + + /*! + * \brief If \c true extra messages will be sent to the terminal, \c false by default. + */ + Q_PROPERTY(bool verbose READ get_verbose WRITE set_verbose RESET reset_verbose) BR_PROPERTY(bool, verbose, false) + + /*! + * \brief The most resent message sent to the terminal. + */ + Q_PROPERTY(QString mostRecentMessage READ get_mostRecentMessage WRITE set_mostRecentMessage RESET reset_mostRecentMessage) BR_PROPERTY(QString, mostRecentMessage, "") + + /*! + * \brief Used internally to compute progress() and timeRemaining(). + */ + Q_PROPERTY(double currentStep READ get_currentStep WRITE set_currentStep RESET reset_currentStep) BR_PROPERTY(double, currentStep, 0) + + /*! + * \brief Used internally to compute progress() and timeRemaining(). + */ + Q_PROPERTY(double totalSteps READ get_totalSteps WRITE set_totalSteps RESET reset_totalSteps) BR_PROPERTY(double, totalSteps, 0) + + /*! + * \brief If \c true enroll 0 or more templates per image, otherwise (default) enroll exactly one. + */ + Q_PROPERTY(bool enrollAll READ get_enrollAll WRITE set_enrollAll RESET reset_enrollAll) BR_PROPERTY(bool, enrollAll, false) QHash abbreviations; /*!< \brief Used by br::Transform::make() to expand abbreviated algorithms into their complete definitions. */ diff --git a/share/openbr/Doxyfile.in b/share/openbr/Doxyfile.in index 29283ec..b371487 100644 --- a/share/openbr/Doxyfile.in +++ b/share/openbr/Doxyfile.in @@ -360,7 +360,7 @@ LOOKUP_CACHE_SIZE = 0 # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES -EXTRACT_ALL = NO +EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. @@ -375,7 +375,7 @@ EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. -EXTRACT_STATIC = NO +EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. @@ -1538,7 +1538,7 @@ INCLUDE_FILE_PATTERNS = # undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = Q_PROPERTY()= BR_EXPORT= +PREDEFINED = BR_EXPORT= # 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