Tweaks to ForceInternal docs (#237)

* Fix readmes

* Tweak method arguments

Author: andrewlock

README.md

@@ -282,7 +282,43 @@ You can set the default metadata source to use for a whole project by setting th
 </PropertyGroup>
 ```
 
-You can override the name of the extension class by setting `ExtensionClassName` in the attribute and/or the namespace of the class by setting `ExtensionClassNamespace`. By default, the class will be public if the enum is public, otherwise it will be internal.
+You can override the name of the extension class by setting `ExtensionClassName` in the attribute and/or the namespace of the class by setting `ExtensionClassNamespace`.
+
+### Controlling extension accessibility
+
+By default, the generated extension class is `public` if the enum is `public`, and `internal` if the enum is `internal`. You can control the accessibility of the generated extension classes in two ways:
+
+**Global Configuration (MSBuild Property):**
+
+Set the `EnumGenerator_ForceInternal` property in your project file to force all generated extension classes to be `internal`:
+
+```xml
+<PropertyGroup>
+  <!-- Make all generated extension classes internal -->
+  <EnumGenerator_ForceInternal>true</EnumGenerator_ForceInternal>
+</PropertyGroup>
+```
+
+Valid values are:
+- `false` (default): Generated extensions follow the enum's accessibility (`public` for `public` enums, `internal` for `internal` enums)
+- `true`: Forces all generated extensions to be `internal`, even for `public` enums
+
+**Per-Enum Configuration:**
+
+You can also set the `IsInternal` property on individual enums using the `[EnumExtensions]` attribute:
+
+```csharp
+// Force this enum's extensions to be internal
+[EnumExtensions(IsInternal = true)]
+public enum MyEnum { ... }
+```
+
+or for external enums:
+
+```csharp
+// Force ExternalEnum's extensions to be internal
+[EnumExtensions<ExternalEnum>(IsInternal = true)]
+```
 
 ## Usage Analyzers
 

src/NetEscapades.EnumGenerators.Generators/EnumGenerator.cs

@@ -96,15 +96,14 @@ static void Execute(
     {
         var useExtensionMembers = compilationDetails.LanguageVersion is not LanguageVersion.Preview and >= (LanguageVersion)1400; // C#14
         var useCollectionExpressions = compilationDetails.LanguageVersion is not LanguageVersion.Preview and >= (LanguageVersion)1200; // C#12
-        var shouldBeInternal = !enumToGenerate.IsPublic || enumToGenerate.ForceInternal ||
-                               defaultValues.ForceInternalAccessModifier;
+        var forceInternal = enumToGenerate.ForceInternal || defaultValues.ForceInternalAccessModifier;
         var (result, filename) = SourceGenerationHelper.GenerateExtensionClass(
             enumToGenerate: in enumToGenerate,
             useExtensionMembers: useExtensionMembers || defaultValues.ForceExtensionMembers,
             useCollectionExpressions: useCollectionExpressions,
             defaultMetadataSource: defaultValues.MetadataSource,
             hasRuntimeDependencies: compilationDetails.HasRuntimeDeps,
-            isInternal: shouldBeInternal);
+            forceInternal: forceInternal);
         context.AddSource(filename, SourceText.From(result, Encoding.UTF8));
     }
 

src/NetEscapades.EnumGenerators.Generators/README.md

@@ -331,11 +331,12 @@ You can also set the `IsInternal` property on individual enums using the `[EnumE
 [EnumExtensions(IsInternal = true)]
 public enum MyEnum { ... }
 ```
+or for external enums:
 
-**Important Rules:**
-- Internal enums always generate internal extensions
-- If the global `EnumGenerator_ForceInternal` MSBuild property is set to `true`, all extensions will be internal regardless of the `IsInternal` attribute setting
-- External enums (referenced via `[EnumExtensions<T>]`) also support the `IsInternal` property
+```csharp
+// Force ExternalEnum's extensions to be internal
+[EnumExtensions<ExternalEnum>(IsInternal = true)]
+```
 
 ## Usage Analyzers
 

src/NetEscapades.EnumGenerators.Generators/SourceGenerationHelper.cs

@@ -25,7 +25,7 @@ public static (string Content, string HintName) GenerateExtensionClass(in EnumTo
         bool useCollectionExpressions,
         MetadataSource defaultMetadataSource,
         bool hasRuntimeDependencies,
-        bool isInternal = false)
+        bool forceInternal)
     {
         var metadataSource = enumToGenerate.MetadataSource ?? defaultMetadataSource;
         var isMetadataSourcesEnabled = metadataSource != MetadataSource.None;
@@ -83,7 +83,7 @@ namespace
             """
             ")]
                 
-            """).Append(isInternal ? "internal" : "public").Append(" static partial class ")
+            """).Append((enumToGenerate.IsPublic && !forceInternal) ? "public" : "internal").Append(" static partial class ")
             .Append(enumToGenerate.Name).Append(
             """
 

src/NetEscapades.EnumGenerators/README.md

@@ -334,10 +334,12 @@ You can also set the `IsInternal` property on individual enums using the `[EnumE
 public enum MyEnum { ... }
 ```
 
-**Important Rules:**
-- Internal enums always generate internal extensions
-- If the global `EnumGenerator_ForceInternal` MSBuild property is set to `true`, all extensions will be internal regardless of the `IsInternal` attribute setting
-- External enums (referenced via `[EnumExtensions<T>]`) also support the `IsInternal` property
+or for external enums:
+
+```csharp
+// Force ExternalEnum's extensions to be internal
+[EnumExtensions<ExternalEnum>(IsInternal = true)]
+```
 
 ## Usage Analyzers
 

tests/NetEscapades.EnumGenerators.Tests/SourceGenerationHelperSnapshotTests.cs

@@ -39,7 +39,8 @@ public Task GeneratesEnumCorrectly(
             csharp14IsSupported,
             useCollectionExpressions: useCollectionExpressions,
             defaultSource,
-            hasRuntimeDeps).Content;
+            hasRuntimeDeps,
+            forceInternal: false).Content;
 
         return Verifier.Verify(result)
             .ScrubExpectedChanges()
@@ -66,8 +67,13 @@ public Task GeneratesEnumWithRepeatedValuesCorrectly(bool csharp14IsSupported)
             hasFlags: false,
             null);
 
-        var result = SourceGenerationHelper.GenerateExtensionClass(value, csharp14IsSupported,
-            useCollectionExpressions: false, DefaultMetadataSource, hasRuntimeDependencies: true).Content;
+        var result = SourceGenerationHelper.GenerateExtensionClass(
+            value,
+            csharp14IsSupported,
+            useCollectionExpressions: false,
+            DefaultMetadataSource,
+            hasRuntimeDependencies: true,
+            forceInternal: false).Content;
 
         return Verifier.Verify(result)
             .ScrubExpectedChanges()
@@ -93,8 +99,13 @@ public Task GeneratesFlagsEnumCorrectly(bool csharp14IsSupported)
             hasFlags: true,
             metadataSource: null);
 
-        var result = SourceGenerationHelper.GenerateExtensionClass(value, csharp14IsSupported,
-            useCollectionExpressions: false, DefaultMetadataSource, hasRuntimeDependencies: true).Content;
+        var result = SourceGenerationHelper.GenerateExtensionClass(
+            value,
+            csharp14IsSupported,
+            useCollectionExpressions: false,
+            DefaultMetadataSource,
+            hasRuntimeDependencies: true,
+            forceInternal: false).Content;
 
         return Verifier.Verify(result)
             .ScrubExpectedChanges()
@@ -125,7 +136,7 @@ public Task GeneratesForcedInternalEnumCorrectly()
             useCollectionExpressions: true,
             MetadataSource.None,
             false,
-            isInternal: true).Content;
+            forceInternal: true).Content;
 
         return Verifier.Verify(result)
             .ScrubExpectedChanges()