From 0f6a8f9bcf57e0c77b9c8d7f83d93dd1be178d41 Mon Sep 17 00:00:00 2001
From: Charles Kerr <charles.kerr@canonical.com>
Date: Wed, 22 Jan 2014 10:03:57 -0600
Subject: copyediting: slightly better header comments/docs

---
 include/datetime/actions-live.h       | 2 +-
 include/datetime/actions.h            | 6 +++++-
 include/datetime/clock.h              | 2 +-
 include/datetime/formatter.h          | 3 +--
 include/datetime/locations-settings.h | 4 ++--
 include/datetime/menu.h               | 4 ++++
 include/datetime/planner-mock.h       | 4 ++--
 include/datetime/planner.h            | 2 ++
 include/datetime/settings.h           | 2 +-
 9 files changed, 19 insertions(+), 10 deletions(-)

diff --git a/include/datetime/actions-live.h b/include/datetime/actions-live.h
index 1947e6e..949222d 100644
--- a/include/datetime/actions-live.h
+++ b/include/datetime/actions-live.h
@@ -27,7 +27,7 @@ namespace indicator {
 namespace datetime {
 
 /**
- * \brief Production implentation of the Actions interface.
+ * \brief Production implementation of the Actions interface.
  *
  * Delegates URLs, sets the timezone via org.freedesktop.timedate1, etc.
  *
diff --git a/include/datetime/actions.h b/include/datetime/actions.h
index a4c6017..18286dc 100644
--- a/include/datetime/actions.h
+++ b/include/datetime/actions.h
@@ -33,7 +33,11 @@ namespace indicator {
 namespace datetime {
 
 /**
- * Interface for all the actions that can be activated by users via the menu.
+ * \brief Interface for all the actions that can be activated by users.
+ *
+ * This is a simple C++ wrapper around our GActionGroup that gets exported
+ * onto the bus. Subclasses implement the actual code that should be run
+ * when a particular action is triggered.
  */
 class Actions
 {
diff --git a/include/datetime/clock.h b/include/datetime/clock.h
index c8e6c16..ffaf4f8 100644
--- a/include/datetime/clock.h
+++ b/include/datetime/clock.h
@@ -61,7 +61,7 @@ private:
     GDBusConnection * m_system_bus = nullptr;
     unsigned int m_sleep_subscription_id = 0;
 
-    // we've got raw pointers in here, so disable copying
+    // we've got raw pointers and GSignal tags in here, so disable copying
     Clock(const Clock&) =delete;
     Clock& operator=(const Clock&) =delete;
 };
diff --git a/include/datetime/formatter.h b/include/datetime/formatter.h
index d8736c7..86fa64a 100644
--- a/include/datetime/formatter.h
+++ b/include/datetime/formatter.h
@@ -45,8 +45,7 @@ class DateTime;
 /**
  * \brief Provide the strftime() format strings
  *
- * This mission's been moved out into its own class because there are
- * a lot of options and edge cases:
+ * This is a simple goal, but getting there has a lot of options and edge cases:
  *
  *  - The default time format can change based on the locale.
  *
diff --git a/include/datetime/locations-settings.h b/include/datetime/locations-settings.h
index 4072736..d01cbb5 100644
--- a/include/datetime/locations-settings.h
+++ b/include/datetime/locations-settings.h
@@ -36,8 +36,8 @@ class SettingsLocations: public Locations
 {
 public:
     /**
-     * @param[in] schemaId the settings schema to load 
-     * @param[in] timezones the timezones to always show first in the list
+     * @param[in] settings the #Settings whose locations property is to be used
+     * @param[in] timezones the #Timezones to always show first in the list
      */
     SettingsLocations (const std::shared_ptr<Settings>& settings,
                        const std::shared_ptr<Timezones>& timezones);
diff --git a/include/datetime/menu.h b/include/datetime/menu.h
index 0bc3781..fcd709f 100644
--- a/include/datetime/menu.h
+++ b/include/datetime/menu.h
@@ -36,6 +36,7 @@ namespace datetime {
  * \brief A menu for a specific profile; eg, Desktop or Phone.
  *
  * @see MenuFactory
+ * @see Exporter
  */
 class Menu
 {
@@ -62,6 +63,9 @@ private:
 
 /**
  * \brief Builds a Menu for a given state and profile
+ *
+ * @see Menu
+ * @see Exporter
  */
 class MenuFactory
 {
diff --git a/include/datetime/planner-mock.h b/include/datetime/planner-mock.h
index bb3ff53..44d30c7 100644
--- a/include/datetime/planner-mock.h
+++ b/include/datetime/planner-mock.h
@@ -27,8 +27,8 @@ namespace indicator {
 namespace datetime {
 
 /**
- * \brief Planner which does nothing on its own and requires
- *        its client to set its appointments property.
+ * \brief Planner which does nothing on its own.
+ *        It requires its client must set its appointments property.
  */
 class MockPlanner: public Planner
 {
diff --git a/include/datetime/planner.h b/include/datetime/planner.h
index 198b6fa..a8f9941 100644
--- a/include/datetime/planner.h
+++ b/include/datetime/planner.h
@@ -63,6 +63,8 @@ protected:
     Planner() =default;
 
 private:
+
+    // disable copying
     Planner(const Planner&) =delete;
     Planner& operator=(const Planner&) =delete;
 };
diff --git a/include/datetime/settings.h b/include/datetime/settings.h
index 418bc33..ce234d9 100644
--- a/include/datetime/settings.h
+++ b/include/datetime/settings.h
@@ -34,7 +34,7 @@ namespace datetime {
  * \brief Interface that represents user-configurable settings.
  *
  * See the descriptions in data/com.canonical.indicator.datetime.gschema.xml
- * For more information.
+ * for more information on specific properties.
  */
 class Settings 
 {
-- 
cgit v1.2.3