Skip to content

Commit 4c288d0

Browse files
v5.2.1 doc improvements
1 parent fff27d5 commit 4c288d0

File tree

5 files changed

+9
-67
lines changed

5 files changed

+9
-67
lines changed

AutomaticInterface/AutomaticInterface/RegisterAttributesExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ namespace AutomaticInterface
2424
/// <summary>
2525
/// Use source generator to automatically create a Interface from this class
2626
/// </summary>
27-
/// <param name="namespaceName">Namespace name for the generated interface. Defaults to the same namespace as the class.</param>
27+
/// <param name="namespaceName22">Namespace name for the generated interface. Defaults to the same namespace as the class.</param>
2828
/// <param name="interfaceName">Interface name for the generated interface. Defaults to an interface version of the class name, e.g ExampleClass -> IExampleClass.</param>
2929
/// <param name="asInternal">If true, the generated interface will be internal, otherwise public</param>
3030
[AttributeUsage(AttributeTargets.Class)]

AutomaticInterface/Tests/Methods/Methods.cs

Lines changed: 0 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -653,27 +653,6 @@ public void AMethod(out int someOutParameter)
653653
654654
""";
655655

656-
const string expected = """
657-
//--------------------------------------------------------------------------------------------------
658-
// <auto-generated>
659-
// This code was generated by a tool.
660-
//
661-
// Changes to this file may cause incorrect behavior and will be lost if the code is regenerated.
662-
// </auto-generated>
663-
//--------------------------------------------------------------------------------------------------
664-
665-
namespace AutomaticInterfaceExample
666-
{
667-
[global::System.CodeDom.Compiler.GeneratedCode("AutomaticInterface", "")]
668-
public partial interface IDemoClass
669-
{
670-
/// <inheritdoc cref="AutomaticInterfaceExample.DemoClass.AMethod(out int)" />
671-
void AMethod(out int someOutParameter);
672-
673-
}
674-
}
675-
676-
""";
677656
await Verify(Infrastructure.GenerateCode(code));
678657
}
679658

@@ -696,27 +675,6 @@ public void AMethod(in int someOutParameter)
696675
697676
""";
698677

699-
const string expected = """
700-
//--------------------------------------------------------------------------------------------------
701-
// <auto-generated>
702-
// This code was generated by a tool.
703-
//
704-
// Changes to this file may cause incorrect behavior and will be lost if the code is regenerated.
705-
// </auto-generated>
706-
//--------------------------------------------------------------------------------------------------
707-
708-
namespace AutomaticInterfaceExample
709-
{
710-
[global::System.CodeDom.Compiler.GeneratedCode("AutomaticInterface", "")]
711-
public partial interface IDemoClass
712-
{
713-
/// <inheritdoc cref="AutomaticInterfaceExample.DemoClass.AMethod(in int)" />
714-
void AMethod(in int someOutParameter);
715-
716-
}
717-
}
718-
719-
""";
720678
await Verify(Infrastructure.GenerateCode(code));
721679
}
722680

@@ -737,28 +695,6 @@ public void AMethod(ref int someOutParameter)
737695
}
738696
}
739697
740-
""";
741-
742-
const string expected = """
743-
//--------------------------------------------------------------------------------------------------
744-
// <auto-generated>
745-
// This code was generated by a tool.
746-
//
747-
// Changes to this file may cause incorrect behavior and will be lost if the code is regenerated.
748-
// </auto-generated>
749-
//--------------------------------------------------------------------------------------------------
750-
751-
namespace AutomaticInterfaceExample
752-
{
753-
[global::System.CodeDom.Compiler.GeneratedCode("AutomaticInterface", "")]
754-
public partial interface IDemoClass
755-
{
756-
/// <inheritdoc cref="AutomaticInterfaceExample.DemoClass.AMethod(ref int)" />
757-
void AMethod(ref int someOutParameter);
758-
759-
}
760-
}
761-
762698
""";
763699
await Verify(Infrastructure.GenerateCode(code));
764700
}

AutomaticInterface/Tests/Tests.csproj

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
<LangVersion>latest</LangVersion>
66
<Configurations>Debug;Release;DebugGenerator</Configurations>
77
<ImplicitUsings>enable</ImplicitUsings>
8+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
9+
<NoWarn>$(NoWarn);CS1591</NoWarn>
810
</PropertyGroup>
911

1012
<ItemGroup>

AutomaticInterface/Tests/test.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
namespace Tests;
22

3-
public interface Itest
3+
public interface ITest
44
{
55
IQueryable<T> AddFilter<T>(IQueryable<T> qry)
66
where T : notnull;
77
}
88

9-
public class test : Itest
9+
public class Test : ITest
1010
{
1111
public IQueryable<T> AddFilter<T>(IQueryable<T> qry)
1212
where T : notnull => qry;

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,10 @@ Note that we use [Verify](https://github.com/VerifyTests/Verify) for testing. It
188188

189189
## Changelog
190190

191+
### 5.2.1
192+
193+
- Smaller fixes to the Docstrings
194+
191195
### 5.2.0
192196

193197
- Allow internal interfaces. Thanks mtren!

0 commit comments

Comments
 (0)