Update documentation.

Qowaiv · Oct 30, 2024 · a6d82cb · a6d82cb
1 parent 873d667
commit a6d82cb
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/specs/Qowaiv.CodeGeneration.Specs/Reflection_specs.cs b/specs/Qowaiv.CodeGeneration.Specs/Reflection_specs.cs
@@ -12,7 +12,7 @@ public void Is_nullable_when_marked()
     public void Is_not_nullable_when_not_marked()
         => typeof(Model).GetProperty(nameof(Model.NotNullable))!.IsNullable().Should().BeFalse();
 
-    class Model
+    internal class Model
     {
         public object? Nullable { get; }
 

diff --git a/src/Qowaiv.CodeGeneration/Extensions/Qowaiv.CodeGeneration.TypeBase.cs b/src/Qowaiv.CodeGeneration/Extensions/Qowaiv.CodeGeneration.TypeBase.cs
@@ -2,10 +2,15 @@
 
 namespace Qowaiv.CodeGeneration;
 
+/// <summary>Extensions on <see cref="TypeBase"/>.</summary>
 public static class TypeBaseExtensions
 {
+    /// <summary>Gets all types including their  usings/dependencies.</summary>
+    /// <remarks>
+    /// That includes all their properties, base classes and derived types.
+    /// </remarks>
     [Pure]
-    public static IReadOnlyCollection<TypeBase> IncludeUsings(this IEnumerable<TypeBase>? codes)
+    public static IReadOnlyCollection<TypeBase> IncludeUsings(this IEnumerable<TypeBase> codes)
     {
         var types = new HashSet<TypeBase>(new TypeNameEqualityComparer());
 

diff --git a/src/Qowaiv.CodeGeneration/IO/CodeFileWriter.cs b/src/Qowaiv.CodeGeneration/IO/CodeFileWriter.cs
@@ -2,8 +2,10 @@
 
 namespace Qowaiv.CodeGeneration.IO;
 
+/// <summary>Writes <see cref="Code"/> to file.</summary>
 public static class CodeFileWriter
 {
+    /// <summary>Saves the <see cref="Code"/> applying writer settings.</summary>
     public static void Save(this IEnumerable<Code> code, CodeFileWriterSettings codeFileSettings, CSharpWriterSettings? csharpSettings = null)
     {
         Guard.NotNull(code);