Merge pull request #408 from leapmotion/fix-comments

Comment fixups

autowiring/CoreContext.h

@@ -521,10 +521,14 @@ class CoreContext:
   template<class Sigil>
   bool Is(void) const { return GetSigilType() == typeid(Sigil); }
 
+  /// <summary>
   /// The first child in the set of this context's children.
+  /// </summary>
   std::shared_ptr<CoreContext> FirstChild(void) const;
 
+  /// <summary>
   /// The next context sharing the same parent, or null if this is the last entry in the list
+  /// </summary>
   std::shared_ptr<CoreContext> NextSibling(void) const;
 
   /// <summary>

autowiring/CoreRunnable.h

@@ -38,20 +38,20 @@ class CoreRunnable {
   const std::shared_ptr<CoreObject>& GetOutstanding(void) const;
 
   /// <summary>
-  /// Invoked by the Start() method. Override this method to perform
-  /// any needed setup;
+  /// Invoked by the Start() method. Override this method to perform any needed setup
   /// </summary>
-  /// <returns>True if processing has started, false otherwise. When overriding, returning false
-  /// will shut down the runnable immediately.</returns>
+  /// <returns>
+  /// True if processing has started, false otherwise. When overriding, returning false will shut down the
+  /// runnable immediately.
+  /// </returns>
   /// <remarks>
-  /// This method will be called at most once.  Returning false from this method will result in an immediate invocation
-  /// of the OnStop(false).
+  /// This method will be called at most once.  Returning false from this method will result in an immediate
+  /// invocation of OnStop(false).
   /// </remarks>
   virtual bool OnStart(void) { return false; };
 
   /// <summary>
-  /// Invoked by the base class Stop() method. Override this method to perform
-  /// any needed cleanup.
+  /// Invoked by the base class Stop() method. Override this method to perform any needed cleanup.
   /// </summary>
   /// <param name="graceful">
   /// Specifies whether the runnable should stop normally or whether it should exit as quickly as possible.

autowiring/DispatchQueue.h

@@ -56,6 +56,8 @@ class DispatchQueue {
   // Notice when the dispatch queue has been updated:
   std::condition_variable m_queueUpdated;
 
+  // True if DispatchQueue::Abort has been called.  This will cause the dispatch queue's remaining entries
+  // to be dumped and prevent the introduction of new entries to the queue.
   bool m_aborted;
 
   /// <summary>