merged with master

effects/fields/boolfield.h

@@ -32,18 +32,67 @@ class BoolField : public EffectField
 {
   Q_OBJECT
 public:
+  /**
+   * @brief See Effect::Effect().
+   */
   BoolField(EffectRow* parent, const QString& id);
 
+  /**
+   * @brief Get the boolean value at a given timecode
+   *
+   * A convenience function, equivalent to GetValueAt(timecode).toBool()
+   *
+   * @param timecode
+   *
+   * The timecode to retrieve the value at
+   *
+   * @return
+   *
+   * The boolean value at this timecode
+   */
   bool GetBoolAt(double timecode);
 
+  /**
+   * @brief See EffectField::CreateWidget()
+   */
   virtual QWidget* CreateWidget(QWidget *existing = nullptr) override;
+
+  /**
+   * @brief See EffectField::UpdateWidgetValue()
+   */
   virtual void UpdateWidgetValue(QWidget* widget, double timecode) override;
 
+  /**
+   * @brief See EffectField::ConvertStringToValue()
+   */
   virtual QVariant ConvertStringToValue(const QString& s) override;
+
+  /**
+   * @brief See EffectField::ConvertValueToString()
+   */
   virtual QString ConvertValueToString(const QVariant& v) override;
 signals:
+  /**
+   * @brief Emitted whenever the UI widget's boolean value has changed
+   *
+   * For any QCheckBox created through this field's CreateWidget() function, this signal is emitted any time the
+   * checkbox value changes (either through user intervention or keyframing). It is mostly useful for
+   * enabling/disabling/changing other UI elements based on the checked
+   * state of this field's value (e.g. enabling other fields if this field is checked).
+   *
+   * It is NOT a reliable signal that the value has changed at all, as it is only emitted if a widget (created
+   * from CreateWidget() ) is currently active.
+   */
   void Toggled(bool);
 private slots:
+  /**
+   * @brief Internal function connected to any QWidget made from CreateWidget() to update the value based on user input
+   *
+   * @param b
+   *
+   * The current checked state of the QWidget (QCheckBox in this case). Automatically set when this slot is connected
+   * to the QCheckBox::toggled() signal.
+   */
   void UpdateFromWidget(bool b);
 };