Moved C++ comments from source files to headers (#1111)

Also sorted functions in C++ sources to match order in related headers.

wpilibc/src/main/native/include/LiveWindow/LiveWindow.h

@@ -25,51 +25,182 @@ class LiveWindow {
   LiveWindow(const LiveWindow&) = delete;
   LiveWindow& operator=(const LiveWindow&) = delete;
 
+  /**
+   * Get an instance of the LiveWindow main class.
+   *
+   * This is a singleton to guarantee that there is only a single instance
+   * regardless of how many times GetInstance is called.
+   */
   static LiveWindow* GetInstance();
 
   WPI_DEPRECATED("no longer required")
-  void Run() { UpdateValues(); }
+  void Run();
 
+  /**
+   * Add a Sensor associated with the subsystem and call it by the given name.
+   *
+   * @param subsystem The subsystem this component is part of.
+   * @param name      The name of this component.
+   * @param component A Sendable component that represents a sensor.
+   */
   WPI_DEPRECATED("use Sendable::SetName() instead")
   void AddSensor(const wpi::Twine& subsystem, const wpi::Twine& name,
                  Sendable* component);
+
+  /**
+   * Add a Sensor associated with the subsystem and call it by the given name.
+   *
+   * @param subsystem The subsystem this component is part of.
+   * @param name      The name of this component.
+   * @param component A Sendable component that represents a sensor.
+   */
   WPI_DEPRECATED("use Sendable::SetName() instead")
   void AddSensor(const wpi::Twine& subsystem, const wpi::Twine& name,
                  Sendable& component);
+
+  /**
+   * Add a Sensor associated with the subsystem and call it by the given name.
+   *
+   * @param subsystem The subsystem this component is part of.
+   * @param name      The name of this component.
+   * @param component A Sendable component that represents a sensor.
+   */
   WPI_DEPRECATED("use Sendable::SetName() instead")
   void AddSensor(const wpi::Twine& subsystem, const wpi::Twine& name,
                  std::shared_ptr<Sendable> component);
+
+  /**
+   * Add an Actuator associated with the subsystem and call it by the given
+   * name.
+   *
+   * @param subsystem The subsystem this component is part of.
+   * @param name      The name of this component.
+   * @param component A Sendable component that represents a actuator.
+   */
   WPI_DEPRECATED("use Sendable::SetName() instead")
   void AddActuator(const wpi::Twine& subsystem, const wpi::Twine& name,
                    Sendable* component);
+
+  /**
+   * Add an Actuator associated with the subsystem and call it by the given
+   * name.
+   *
+   * @param subsystem The subsystem this component is part of.
+   * @param name      The name of this component.
+   * @param component A Sendable component that represents a actuator.
+   */
   WPI_DEPRECATED("use Sendable::SetName() instead")
   void AddActuator(const wpi::Twine& subsystem, const wpi::Twine& name,
                    Sendable& component);
+
+  /**
+   * Add an Actuator associated with the subsystem and call it by the given
+   * name.
+   *
+   * @param subsystem The subsystem this component is part of.
+   * @param name      The name of this component.
+   * @param component A Sendable component that represents a actuator.
+   */
   WPI_DEPRECATED("use Sendable::SetName() instead")
   void AddActuator(const wpi::Twine& subsystem, const wpi::Twine& name,
                    std::shared_ptr<Sendable> component);
 
+  /**
+   * Meant for internal use in other WPILib classes.
+   *
+   * @deprecated Use SendableBase::SetName() instead.
+   */
   WPI_DEPRECATED("use SensorUtil::SetName() instead")
   void AddSensor(const wpi::Twine& type, int channel, Sendable* component);
+
+  /**
+   * Meant for internal use in other WPILib classes.
+   *
+   * @deprecated Use SendableBase::SetName() instead.
+   */
   WPI_DEPRECATED("use SensorUtil::SetName() instead")
   void AddActuator(const wpi::Twine& type, int channel, Sendable* component);
+
+  /**
+   * Meant for internal use in other WPILib classes.
+   *
+   * @deprecated Use SendableBase::SetName() instead.
+   */
   WPI_DEPRECATED("use SensorUtil::SetName() instead")
   void AddActuator(const wpi::Twine& type, int module, int channel,
                    Sendable* component);
 
+  /**
+   * Add a component to the LiveWindow.
+   *
+   * @param sendable component to add
+   */
   void Add(std::shared_ptr<Sendable> component);
+
+  /**
+   * Add a component to the LiveWindow.
+   *
+   * @param sendable component to add
+   */
   void Add(Sendable* component);
+
+  /**
+   * Add a child component to a component.
+   *
+   * @param parent parent component
+   * @param child child component
+   */
   void AddChild(Sendable* parent, std::shared_ptr<Sendable> component);
+
+  /**
+   * Add a child component to a component.
+   *
+   * @param parent parent component
+   * @param child child component
+   */
   void AddChild(Sendable* parent, void* component);
+
+  /**
+   * Remove the component from the LiveWindow.
+   *
+   * @param sendable component to remove
+   */
   void Remove(Sendable* component);
 
+  /**
+   * Enable telemetry for a single component.
+   *
+   * @param sendable component
+   */
   void EnableTelemetry(Sendable* component);
+
+  /**
+   * Disable telemetry for a single component.
+   *
+   * @param sendable component
+   */
   void DisableTelemetry(Sendable* component);
+
+  /**
+   * Disable ALL telemetry.
+   */
   void DisableAllTelemetry();
 
   bool IsEnabled() const;
+
+  /**
+   * Change the enabled status of LiveWindow.
+   *
+   * If it changes to enabled, start livewindow running otherwise stop it
+   */
   void SetEnabled(bool enabled);
 
+  /**
+   * Tell all the sensors to update (send) their values.
+   *
+   * Actuators are handled through callbacks on their value changing from the
+   * SmartDashboard widgets.
+   */
   void UpdateValues();
 
  private: