Fix line length.

[modules/shaper.git] / src / Config / Config_SelectionFilterMessage.h

diff --git a/src/Config/Config_SelectionFilterMessage.h b/src/Config/Config_SelectionFilterMessage.h
index d43b41382d426986320e570d71b9024450429768..ed661b93c599173378c22601d7c67f9c1a125429 100644 (file)
--- a/src/Config/Config_SelectionFilterMessage.h
+++ b/src/Config/Config_SelectionFilterMessage.h
@@ -19,6 +19,11 @@
 /// Event ID that Selection Filter is loaded (comes with Config_SelectionFilterMessage)
 static const char * EVENT_SELFILTER_LOADED = "SelectionFilterLoaded";
 
+/*!
+ * \class Config_SelectionFilterMessage
+ * \ingroup Config
+ * \brief Transmits info about selection filters on "SelectionFilterLoaded" event
+ */
 class Config_SelectionFilterMessage : public Events_Message
 {
   std::string mySelectionFilterId;
@@ -27,17 +32,30 @@ class Config_SelectionFilterMessage : public Events_Message
   std::list<std::string> myFilterParameters;
 
  public:
+  /*!
+   * Constructor.
+   * \param theId - Events_ID of the message
+   * \param theParent - pointer to the sender
+   */
   CONFIG_EXPORT Config_SelectionFilterMessage(const Events_ID theId, const void* theParent = 0);
   CONFIG_EXPORT virtual ~Config_SelectionFilterMessage();
 
+  //! Get id of the filter
   CONFIG_EXPORT const std::string& selectionFilterId() const;
+  //! Get id of a feature to which the filter belongs to
   CONFIG_EXPORT const std::string& featureId() const;
+  //! Get id of an attribute to which the filter belongs to
   CONFIG_EXPORT const std::string& attributeId() const;
+  //! Get filter parameters
   CONFIG_EXPORT const std::list<std::string>& parameters() const;
 
+  //! Set id of the filter
   CONFIG_EXPORT void setSelectionFilterId(const std::string& theId);
+  //! Set id of a feature to which the filter belongs to
   CONFIG_EXPORT void setFeatureId(const std::string& theId);
+  //! Set id of an attribute to which the filter belongs to
   CONFIG_EXPORT void setAttributeId(const std::string& theId);
+  //! Get filter parameters
   CONFIG_EXPORT void setFilterParameters(const std::list<std::string>& parameters);
 };