Skip to content

Commit 7d2a936

Browse files
committed
Add XMLDoc to public classes
1 parent 8286546 commit 7d2a936

4 files changed

Lines changed: 32 additions & 1 deletion

File tree

src/UnityContainerAttributeRegistration/Adapter/IAppDomainAdapter.cs

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@
44

55
namespace UnityContainerAttributeRegistration.Adapter
66
{
7+
/// <summary>
8+
/// Wrapper to provide <see cref="IList{Assembly}"/> instead of using <see cref="System.AppDomain"/>
9+
/// </summary>
710
public interface IAppDomainAdapter
811
{
12+
/// <summary>
13+
/// Provice <see cref="Assembly"/>s of an AppDomain
14+
/// </summary>
15+
/// <returns><see cref="Assembly"/>s which are used to populate </returns>
916
public IList<Assembly> GetAssemblies();
1017
}
1118
}

src/UnityContainerAttributeRegistration/Attribute/RegisterTypeAttribute.cs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,14 @@
55

66
namespace UnityContainerAttributeRegistration.Attribute
77
{
8+
/// <summary>
9+
/// Mark a class to be registered to an <see cref="Unity.IUnityContainer"/>
10+
/// </summary>
811
[AttributeUsage(AttributeTargets.Class)]
912
public class RegisterTypeAttribute : System.Attribute
1013
{
14+
/// <param name="from"><see cref="Type"/> that will be requested.</param>
15+
/// <param name="lifetimeManager">The <see cref="Unity.Lifetime.ITypeLifetimeManager"/> that controls the lifetime of the returned instance.</param>
1116
public RegisterTypeAttribute([CanBeNull] Type from = null,
1217
[CanBeNull] Type lifetimeManager = null)
1318
{

src/UnityContainerAttributeRegistration/TypeDefined.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
namespace UnityContainerAttributeRegistration
22
{
3-
public enum TypeDefined
3+
internal enum TypeDefined
44
{
55
Inherit,
66
NotInherit

src/UnityContainerAttributeRegistration/UnityContainerPopulator.cs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,43 @@
1414

1515
namespace UnityContainerAttributeRegistration
1616
{
17+
/// <summary>
18+
/// Creates a populated or populates an <see cref="Unity.IUnityContainer" />, depending on the provided assemblies
19+
/// </summary>
1720
public sealed class UnityContainerPopulator
1821
{
1922
private readonly IAppDomainAdapter appDomain;
2023

24+
/// <summary>
25+
/// Use <see cref="System.AppDomain.CurrentDomain"/> to populate an <see cref="Unity.IUnityContainer" />
26+
/// </summary>
2127
public UnityContainerPopulator() : this(new AppDomainAdapter())
2228
{
2329
}
2430

31+
/// <summary>
32+
/// Use <paramref name="appDomain"/> to populate an <see cref="Unity.IUnityContainer" />
33+
/// </summary>
34+
/// <param name="appDomain">Custom <see cref="UnityContainerAttributeRegistration.Adapter.IAppDomainAdapter"/></param>
2535
public UnityContainerPopulator([NotNull] IAppDomainAdapter appDomain)
2636
{
2737
this.appDomain = appDomain;
2838
}
2939

40+
/// <summary>
41+
/// Create and populate a new <see cref="Unity.UnityContainer"/>
42+
/// </summary>
43+
/// <returns>New <see cref="Unity.UnityContainer"/> with registered types</returns>
3044
public IUnityContainer Populate()
3145
{
3246
return Populate(new UnityContainer());
3347
}
3448

49+
/// <summary>
50+
/// Populate <paramref name="container"/>
51+
/// </summary>
52+
/// <param name="container"><see cref="Unity.IUnityContainer"/> to register types</param>
53+
/// <returns><paramref name="container"/></returns>
3554
public IUnityContainer Populate([NotNull] IUnityContainer container)
3655
{
3756
RegisterByTypeAttribute(container);

0 commit comments

Comments
 (0)