Commit 18c0fe76dcae3d6256819d2557d553107f2a4625
1 parent
dcb9e955
Additional comments about added parameters/methods.
Showing
1 changed file
with
3 additions
and
2 deletions
openbr/openbr_plugin.h
| @@ -589,9 +589,10 @@ public: | @@ -589,9 +589,10 @@ public: | ||
| 589 | File file; /*!< \brief The file used to construct the plugin. */ | 589 | File file; /*!< \brief The file used to construct the plugin. */ |
| 590 | 590 | ||
| 591 | virtual void init() {} /*!< \brief Overload this function instead of the default constructor to initialize the derived class. It should be safe to call this function multiple times. */ | 591 | virtual void init() {} /*!< \brief Overload this function instead of the default constructor to initialize the derived class. It should be safe to call this function multiple times. */ |
| 592 | - virtual void store(QDataStream &stream, bool force = false) const; /*!< \brief Serialize the object. */ | 592 | + virtual void store(QDataStream &stream, bool force = false) const; /*!< \brief Serialize the object. If force is true, classes must serialize directly on the stream not to e.g. a separate file. */ |
| 593 | virtual void load(QDataStream &stream); /*!< \brief Deserialize the object. Default implementation calls init() after deserialization. */ | 593 | virtual void load(QDataStream &stream); /*!< \brief Deserialize the object. Default implementation calls init() after deserialization. */ |
| 594 | 594 | ||
| 595 | + /*!< \brief Serialize an object created via the plugin system, including the string used to build the base object, allowing re-creation of the object without knowledge of its base string*/ | ||
| 595 | virtual void serialize(QDataStream &stream, bool force) | 596 | virtual void serialize(QDataStream &stream, bool force) |
| 596 | { | 597 | { |
| 597 | stream << description(force); | 598 | stream << description(force); |
| @@ -599,7 +600,7 @@ public: | @@ -599,7 +600,7 @@ public: | ||
| 599 | } | 600 | } |
| 600 | 601 | ||
| 601 | QStringList parameters() const; /*!< \brief A string describing the parameters the object takes. */ | 602 | QStringList parameters() const; /*!< \brief A string describing the parameters the object takes. */ |
| 602 | - QStringList arguments(bool expanded = false); /*!< \brief A string describing the values the object has. */ | 603 | + QStringList arguments(bool expanded = false); /*!< \brief A string describing the values the object has. If expanded is true, all abbreviations and model file names should be replaced with a description of the object generated from those names. */ |
| 603 | QString argument(int index, bool expanded) const; /*!< \brief A string value for the argument at the specified index. */ | 604 | QString argument(int index, bool expanded) const; /*!< \brief A string value for the argument at the specified index. */ |
| 604 | virtual QString description(bool expanded = false); /*!< \brief Returns a string description of the object. */ | 605 | virtual QString description(bool expanded = false); /*!< \brief Returns a string description of the object. */ |
| 605 | 606 |