Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix obsolete comments #864

Merged
merged 2 commits into from
Mar 17, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/autowiring/BoltBase.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ class CoreContext;

/// <summary>
/// </summary>
/// <param name="contextName">The name of the context whose creation we want to listen for</param>
/// <remarks>
/// </remarks>
class BoltBase
Expand Down
11 changes: 5 additions & 6 deletions src/autowiring/CoreContext.h
Original file line number Diff line number Diff line change
Expand Up @@ -61,20 +61,19 @@ enum class ShutdownMode {
/// A context is the basic unit of organization within an autowired application. The scope of a context
/// determines:
/// * How Autowired dependencies are resolved
/// * Who receives AutoFired events
/// * Thread ownership (BasicThread, CoreThread)
/// * AutoPacket filter graph scope
///
/// Dependencies can be injected into a context using Autowired or AutoRequired.
/// The system looks in the current context for an existing object of the required
/// type to satisfy the dependency. If one does not exist, it looks in parent contexts.
/// When using AutoRequired, a new instance of the required type is created if no
/// existing object is found. Otherwise, the dependoncy is satisfied when another
/// existing object is found. Otherwise, the dependency is satisfied when another
/// object of the same type (or subtype) is added to the context (or one of its
/// parents). This resolution system carries the restriction that only one instance
/// of an Autowired type can exist in the same branch of the context tree.
///
/// In addition, an Autowired member of a context exists for as long as that context.
/// In addition, an Autowired member of a context exists for as long as that context
/// exists.
///
/// Autowired dependencies do not need to meet any special requirements such as
Expand All @@ -93,13 +92,13 @@ enum class ShutdownMode {
///
/// \include snippets/Context_Class_Enumerate.txt
///
/// Autowired members of a context can pass information using AutoFired events, as well as with a filter graph.
/// Autowired members of a context can pass information with a filter graph.
/// You can also pass data from one context to another in the same way. A context can also snoop on another context's
/// events and filter graph packets to receive data it wouldn't otherwise have access to. Use Bolt objects to receive
/// filter graph packets to receive data it wouldn't otherwise have access to. Use Bolt objects to receive
/// notification when a context of a particular sigil type is created. This allows you to set up snooping
/// whenever a particular type of context is created.
///
/// Events, threads, and filter graphs require that the context's Initiate() function is called.
/// Threads and filter graphs require that the context's Initiate() function is called.
/// </remarks>
class CoreContext:
public std::enable_shared_from_this<CoreContext>
Expand Down