Skip to content

Commit ee01b36

Browse files
committed
Grammar
1 parent f3de86f commit ee01b36

File tree

1 file changed

+25
-24
lines changed

1 file changed

+25
-24
lines changed

src/Abstracts/IUnityContainer.cs

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,13 @@ public interface IUnityContainer : IDisposable
1919
/// Register a type or a type mapping with the container.
2020
/// </summary>
2121
/// <param name="registeredType">Registration <see cref="Type"/>. This <see cref="Type"/> will be
22-
/// requested when resolving. It is also could be refereed as <c>FromType</c> or <c>ServiceType</c></param>
23-
/// <param name="mappedToType">A <see cref="Type"/> that will actually be returned. Sometimes this type is referred
22+
/// requested when resolving. Sometimes referred as <c>FromType</c> or <c>ServiceType</c></param>
23+
/// <param name="mappedToType">A <see cref="Type"/> that will actually be returned. Also referred
2424
/// as <c>ToType</c> or <c>ImplementationType</c>.</param>
2525
/// <param name="name">Name of the registration</param>
2626
/// <param name="lifetimeManager">The <see cref="TypeLifetime"/> that controls the lifetime of the returned instance.
2727
/// If <paramref name="lifetimeManager"/> is null, container uses <see cref="TypeLifetime.Transient"/> lifetime.</param>
28-
/// <param name="injectionMembers">Injection configuration objects. Can be null.</param>
28+
/// <param name="injectionMembers">Optional injection configuration objects</param>
2929
/// <remarks>
3030
/// <para>
3131
/// Container stores registrations by <paramref name="registeredType"/> <see cref="Type"/>. When resolving, it will look
@@ -36,27 +36,27 @@ public interface IUnityContainer : IDisposable
3636
/// </para>
3737
/// <para>
3838
/// Type <paramref name="mappedToType"/> will not be registered with the container. It will only be used to inform container how to
39-
/// build the requested instance or where to redirect to satisfy the request. If type provided in <paramref name="mappedToType"/>
39+
/// build the requested instance or where to redirect to satisfy the request. If the type provided in <paramref name="mappedToType"/>
4040
/// is already registered with the container, the registration creates a mapping to the existing registration. It will redirect to that
4141
/// registration when creating an object.
4242
/// </para>
4343
/// <para>
44-
/// If <paramref name="injectionMembers"/> collection is not empty, the mapping will not redirect to other registrations. Instead it will
44+
/// If <paramref name="injectionMembers"/> collection is not empty, the mapping will not redirect to other registrations. Instead, it will
4545
/// always build the <see cref="Type"/> according to the rules set by provided <see cref="InjectionMember"/> objects.
4646
/// </para>
4747
/// <para>
4848
/// Registering a <see cref="Type"/> with the same <paramref name="name"/> second time will overwrite previous registration. When
49-
/// overwritten, registration will dispose lifetime manager it was registered with and if that manager hold a reference to an instance
50-
/// of disposable object (the object implements <see cref="IDisposable"/>), it will be disposed as well.
49+
/// overwritten, registration will dispose of lifetime manager it was registered with and if that manager holds a reference to an instance
50+
/// of a disposable object (the object implements <see cref="IDisposable"/>), it will be disposed of as well.
5151
/// </para>
5252
/// <para>
53-
/// During registration Unity performs only limited number of checks. To enable slower but more thorough and detailed validation add
53+
/// During registration, Unity performs only a limited number of checks. To enable slower but more thorough and detailed validation add
5454
/// <c>Diagnostic</c> extension to the container.
5555
/// </para>
5656
/// </remarks>
5757
/// <example>
58-
/// This example registers a default (no name) singleton service. The service will be created with default constructor, field and property <c>Resolved</c> and
59-
/// <c>Injected</c> are initialized with resolved and injected values respectively, and method <c>Init</c> is called on the
58+
/// This example registers a default (no name) singleton service. The service will be created with a default constructor, field and property
59+
/// <c>Resolved</c> and <c>Injected</c> are initialized with resolved and injected values respectively, and method <c>Init</c> is called on the
6060
/// created object.
6161
/// <code>
6262
/// c.RegisterType(typeof(IService), // Type to register
@@ -98,18 +98,18 @@ public interface IUnityContainer : IDisposable
9898
/// <list type="bullet">
9999
/// <item>
100100
/// <term><see cref="InstanceLifetime.External"/></term>
101-
/// <description>- Instance is managed elsewhere. Container holds just a weak reference to the instance. An author is responsible for
101+
/// <description>- Instance is managed elsewhere. The container holds just a weak reference to the instance. An author is responsible for
102102
/// making sure the instance is not going out of scope and garbage collected while still being used by the container.</description>
103103
/// </item>
104104
/// <item>
105105
/// <term><see cref="InstanceLifetime.Singleton"/></term>
106-
/// <description>- The instance is registered as global singleton. This type of lifetime registers the instance with the root container
107-
/// and makes it available to all descendants. It does not matter if instance is registered with root container or any child containers,
106+
/// <description>- The instance is registered as a global singleton. This type of lifetime registers the instance with the root container
107+
/// and makes it available to all descendants. It does not matter if an instance is registered with root container or any child containers,
108108
/// the registration is always stored at the root.</description>
109109
/// </item>
110110
/// <item>
111111
/// <term><see cref="InstanceLifetime.PerContainer"/></term>
112-
/// <description>- Instance is registered with particular container and is available within the container and all it's descendants.</description>
112+
/// <description>- Instance is registered with a particular container and is available within the container and all its descendants.</description>
113113
/// </item>
114114
/// </list>
115115
/// </para>
@@ -167,15 +167,15 @@ public interface IUnityContainer : IDisposable
167167
/// <param name="type"><see cref="Type"/> to look for</param>
168168
/// <param name="name">Name of the registration</param>
169169
/// <remarks>
170-
/// <para>This method checks if <see cref="Type"/> with specified <paramref name="name"/> is registered with the container.</para>
170+
/// <para>This method checks if <see cref="Type"/> with the specified <paramref name="name"/> is registered with the container.</para>
171171
/// <para>
172-
/// When method verifies if <see cref="Type"/> is registered, it looks not only into current container
172+
/// When method verifies if <see cref="Type"/> is registered, it looks not only into the current container
173173
/// by all its predecessors as well. So if this <see cref="Type"/> not registered in the container but
174174
/// contained by one of its parents it will still return <c>True</c>.
175175
/// </para>
176176
/// <para>
177177
/// This method is quite fast. It uses the same algorithm the container employs to obtain registrations
178-
/// and has very small overhead. It is order of magnitude faster than querying <see cref="IUnityContainer.Registrations"/>
178+
/// and has a very small overhead. It is an order of magnitude faster than querying <see cref="IUnityContainer.Registrations"/>
179179
/// collection.
180180
/// </para>
181181
/// </remarks>
@@ -200,6 +200,7 @@ public interface IUnityContainer : IDisposable
200200
/// </para>
201201
/// </remarks>
202202
/// <seealso cref="IContainerRegistration"/>
203+
/// <value>Registered with the container types</value>
203204
IEnumerable<IContainerRegistration> Registrations { get; }
204205

205206

@@ -213,16 +214,16 @@ public interface IUnityContainer : IDisposable
213214
/// <para>
214215
/// During resolution Unity checks if <see cref="Type"/> is registered and uses that registration to create an object.
215216
/// If <see cref="Type"/> is not registered it uses reflection to get information about the <see cref="Type"/> and
216-
/// creates pipeline to instantiate and initialize the <see cref="Type"/> using reflected data.
217+
/// creates a pipeline to instantiate and initialize the <see cref="Type"/> using reflected data.
217218
/// </para>
218219
/// <para>
219-
/// Resolver overrides passed to the method will only override dependencies configured for injection. For example if
220+
/// Resolver overrides passed to the method will only override dependencies configured for injection. For example, if
220221
/// some members were marked with attributes to be injected or registered with associated <see cref="InjectionMember"/>
221222
/// objects, only these members will be available for overriding. Override values for members not configured for injection
222223
/// will be ignored.
223224
/// </para>
224225
/// <para>
225-
/// During resolution Unity performs only limited number of checks. If any errors occur, error information is very brief.
226+
/// During resolution, Unity performs only a limited number of checks. If any errors occur, error information is very brief.
226227
/// To enable slower but more thorough and detailed validation and expanded error reporting add <c>Diagnostic</c>
227228
/// extension to the container.
228229
/// </para>
@@ -242,7 +243,7 @@ public interface IUnityContainer : IDisposable
242243
/// <param name="overrides">Any overrides for the resolve calls.</param>
243244
/// <remarks>
244245
/// <para>
245-
/// This method performs all the initializations and injections on an instance of object you
246+
/// This method performs all the initializations and injections on an instance of an object you
246247
/// passed in <paramref name="existing"/>.
247248
/// </para>
248249
/// <para>
@@ -263,7 +264,7 @@ public interface IUnityContainer : IDisposable
263264
/// The parent of this container.
264265
/// </summary>
265266
/// <remarks>
266-
/// If the instance of the container is a child container, this property will hold reference to
267+
/// If the instance of the container is a child container, this property will hold a reference to
267268
/// the container that created this instance.
268269
/// </remarks>
269270
/// <value>The parent container, or null if this container doesn't have one.</value>
@@ -274,8 +275,8 @@ public interface IUnityContainer : IDisposable
274275
/// Create a child container.
275276
/// </summary>
276277
/// <remarks>
277-
/// A child container shares the parent's configuration, but can be configured with different
278-
/// settings or lifetime.</remarks>
278+
/// Unity allows creating scopes with the help of child container. A child container shares the
279+
/// parent's configuration but can be configured with different settings or lifetime.</remarks>
279280
/// <returns>The new child container.</returns>
280281
IUnityContainer CreateChildContainer();
281282
}

0 commit comments

Comments
 (0)