Skip to content

Commit

Permalink
Comment fixups
Browse files Browse the repository at this point in the history
Very small changes to address some formatting inconsistencies in comments noticed while working on an unrelated pull request.
  • Loading branch information
codemercenary committed Feb 11, 2015
1 parent f97b758 commit c4ebf5a
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 10 deletions.
4 changes: 4 additions & 0 deletions autowiring/CoreContext.h
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
21 changes: 11 additions & 10 deletions autowiring/CoreRunnable.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,26 +38,27 @@ 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>
/// <remarks>
/// This method will be called at most once.
/// </remarks>
/// <param name="graceful">Specifies whether the runnable should stop normally or whether
/// it should exit as quickly as possible.</param>
/// <param name="graceful">
/// Specifies whether the runnable should stop normally or whether it should exit as quickly as possible.
/// </param>
virtual void OnStop(bool graceful) {};

/// <summary>
Expand Down
2 changes: 2 additions & 0 deletions autowiring/DispatchQueue.h
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit c4ebf5a

Please sign in to comment.