Add comments for add/clear slots.

0ea3c4e5 · Martin Heistermann · 0d0e37ad · 0ea3c4e5
Commit 0ea3c4e5 authored Apr 23, 2020 by Martin Heistermann
Hide whitespace changes
Inline Side-by-side

Showing with 8 additions and 0 deletions

PropertyVisPlugin.hh PropertyVisPlugin.hh +8 -0

No files found.
--- a/PropertyVisPlugin.hh
+++ b/PropertyVisPlugin.hh
@@ -149,8 +149,16 @@ private slots:


 public slots:
+  /// Visualise a property on object _id with the given name.
+  /// Note that for multiple properties with the same name (i.e., different
+  ///  data types or entity types), there is no guarantee which one is used.
  void slotVisualizeProperty( int _id, const QString& _propname );
+
+  /// Remove visualisation of a property on object _id with the given name.
+  /// Note that for multiple properties with the same name (i.e., different
+  ///  data types or entity types), there is no guarantee which one is used.
  void slotClear( int _id, const QString& _propname );
+
  QScriptValue getPropertyVisualizer( int _id, const QString& _propname );