Commit 36a08ae453a3a2a10ae9623f925b704a9efd2b1c
1 parent
0bdd4455
Removed doxygen comments
Showing
1 changed file
with
2 additions
and
37 deletions
openbr/plugins/openbr_internal.h
| ... | ... | @@ -6,9 +6,7 @@ |
| 6 | 6 | |
| 7 | 7 | namespace br |
| 8 | 8 | { |
| 9 | -/*! | |
| 10 | - * \brief A br::Transform that does not require training data. | |
| 11 | - */ | |
| 9 | + | |
| 12 | 10 | class BR_EXPORT UntrainableTransform : public Transform |
| 13 | 11 | { |
| 14 | 12 | Q_OBJECT |
| ... | ... | @@ -23,9 +21,7 @@ private: |
| 23 | 21 | void load(QDataStream &stream) { (void) stream; } |
| 24 | 22 | }; |
| 25 | 23 | |
| 26 | -/*! | |
| 27 | - * \brief A br::Transform expecting multiple matrices per template. | |
| 28 | - */ | |
| 24 | + | |
| 29 | 25 | class BR_EXPORT MetaTransform : public Transform |
| 30 | 26 | { |
| 31 | 27 | Q_OBJECT |
| ... | ... | @@ -34,9 +30,6 @@ protected: |
| 34 | 30 | MetaTransform() : Transform(false) {} |
| 35 | 31 | }; |
| 36 | 32 | |
| 37 | -/*! | |
| 38 | - * \brief A br::MetaTransform that does not require training data. | |
| 39 | - */ | |
| 40 | 33 | class BR_EXPORT UntrainableMetaTransform : public UntrainableTransform |
| 41 | 34 | { |
| 42 | 35 | Q_OBJECT |
| ... | ... | @@ -97,9 +90,6 @@ private: |
| 97 | 90 | Transform *baseTransform; |
| 98 | 91 | }; |
| 99 | 92 | |
| 100 | -/*! | |
| 101 | - * \brief A br::Transform for which the results of project may change due to prior calls to project | |
| 102 | - */ | |
| 103 | 93 | class BR_EXPORT TimeVaryingTransform : public Transform |
| 104 | 94 | { |
| 105 | 95 | Q_OBJECT |
| ... | ... | @@ -135,10 +125,6 @@ public: |
| 135 | 125 | } |
| 136 | 126 | } |
| 137 | 127 | |
| 138 | - /*! | |
| 139 | - *\brief For transforms that don't do any training, this default implementation | |
| 140 | - * which creates a new copy of the Transform from its description string is sufficient. | |
| 141 | - */ | |
| 142 | 128 | virtual Transform *smartCopy(bool &newTransform) |
| 143 | 129 | { |
| 144 | 130 | newTransform = true; |
| ... | ... | @@ -155,9 +141,6 @@ protected: |
| 155 | 141 | } |
| 156 | 142 | }; |
| 157 | 143 | |
| 158 | -/*! | |
| 159 | - * \brief Interface for transforms that act as decorators of another transform | |
| 160 | - */ | |
| 161 | 144 | class BR_EXPORT WrapperTransform : public TimeVaryingTransform |
| 162 | 145 | { |
| 163 | 146 | Q_OBJECT |
| ... | ... | @@ -261,9 +244,6 @@ public: |
| 261 | 244 | |
| 262 | 245 | }; |
| 263 | 246 | |
| 264 | -/*! | |
| 265 | - * \brief A MetaTransform that aggregates some sub-transforms | |
| 266 | - */ | |
| 267 | 247 | class BR_EXPORT CompositeTransform : public TimeVaryingTransform |
| 268 | 248 | { |
| 269 | 249 | Q_OBJECT |
| ... | ... | @@ -303,12 +283,6 @@ public: |
| 303 | 283 | } |
| 304 | 284 | } |
| 305 | 285 | |
| 306 | - /*! | |
| 307 | - * \brief Composite transforms need to create a copy of themselves if they | |
| 308 | - * have any time-varying children. If this object is flagged as time-varying, | |
| 309 | - * it creates a new copy of its own class, and gives that copy the child transforms | |
| 310 | - * returned by calling smartCopy on this transforms children | |
| 311 | - */ | |
| 312 | 286 | Transform *smartCopy(bool &newTransform) |
| 313 | 287 | { |
| 314 | 288 | if (!timeVarying()) { |
| ... | ... | @@ -405,9 +379,6 @@ struct WorkerProcess |
| 405 | 379 | void mainLoop(); |
| 406 | 380 | }; |
| 407 | 381 | |
| 408 | -/*! | |
| 409 | - * \brief A br::Transform that operates solely on metadata | |
| 410 | - */ | |
| 411 | 382 | class MetadataTransform : public Transform |
| 412 | 383 | { |
| 413 | 384 | Q_OBJECT |
| ... | ... | @@ -425,9 +396,6 @@ protected: |
| 425 | 396 | MetadataTransform(bool trainable = true) : Transform(false,trainable) {} |
| 426 | 397 | }; |
| 427 | 398 | |
| 428 | -/*! | |
| 429 | - * \brief A br::Transform that operates solely on metadata, and is untrainable | |
| 430 | - */ | |
| 431 | 399 | class UntrainableMetadataTransform : public MetadataTransform |
| 432 | 400 | { |
| 433 | 401 | Q_OBJECT |
| ... | ... | @@ -478,9 +446,6 @@ typedef QVector<Neighbors> Neighborhood; |
| 478 | 446 | |
| 479 | 447 | BR_EXPORT bool compareNeighbors(const Neighbor &a, const Neighbor &b); |
| 480 | 448 | |
| 481 | -/*! | |
| 482 | - * \brief A br::Distance that does not require training data. | |
| 483 | - */ | |
| 484 | 449 | class BR_EXPORT UntrainableDistance : public Distance |
| 485 | 450 | { |
| 486 | 451 | Q_OBJECT | ... | ... |