Skip to content

Commit

Permalink
Reuse doc on root namespace and add visibility doc
Browse files Browse the repository at this point in the history
  • Loading branch information
kzu committed Sep 27, 2024
1 parent eae9ec1 commit c95ff1a
Show file tree
Hide file tree
Showing 10 changed files with 26 additions and 23 deletions.
2 changes: 2 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,8 @@ generated `ThisAssembly` class. Otherwise, it will be generated in the global na
<!-- #strings -->
<!-- src/ThisAssembly.Strings/readme.md#strings -->

<!-- include ../visibility.md -->

# Dogfooding

[![CI Version](https://img.shields.io/endpoint?url=https://shields.kzu.io/vpre/Stunts/main&label=nuget.ci&color=brightgreen)](https://pkg.kzu.io/index.json)
Expand Down
4 changes: 1 addition & 3 deletions src/ThisAssembly.AssemblyInfo/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ on the `ThisAssembly.Info` class.

![](https://raw.githubusercontent.com/devlooped/ThisAssembly/main/img/ThisAssembly.AssemblyInfo.png)

Set the `$(ThisAssemblyNamespace)` MSBuild property to set the root namespace of the
generated `ThisAssembly` class. Otherwise, it will be generated in the global namespace.

<!-- #assembly -->
<!-- include ../visibility.md -->
<!-- include https://github.com/devlooped/sponsors/raw/main/footer.md -->
<!-- exclude -->
5 changes: 1 addition & 4 deletions src/ThisAssembly.Constants/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ via environment variables or command line arguments. For example:
The C# code could consume this constant as follows:

```csharp

public HttpClient CreateHttpClient(string name, int? timeout = default)
{
HttpClient client = httpClientFactory.CreateClient(name);
Expand Down Expand Up @@ -65,9 +64,7 @@ Which results in:

![](https://raw.githubusercontent.com/devlooped/ThisAssembly/main/img/ThisAssembly.Constants2.png)

Set the `$(ThisAssemblyNamespace)` MSBuild property to set the root namespace of the
generated `ThisAssembly` class. Otherwise, it will be generated in the global namespace.

<!-- #constants -->
<!-- include ../visibility.md -->
<!-- include https://github.com/devlooped/sponsors/raw/main/footer.md -->
<!-- exclude -->
5 changes: 1 addition & 4 deletions src/ThisAssembly.Git/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,7 @@ packaging experience possible:
</Project>
```

Set the `$(ThisAssemblyNamespace)` MSBuild property to set the root namespace of the
generated `ThisAssembly` class. Otherwise, it will be generated in the global namespace.


<!-- #git -->
<!-- include ../visibility.md -->
<!-- include https://github.com/devlooped/sponsors/raw/main/footer.md -->
<!-- exclude -->
4 changes: 1 addition & 3 deletions src/ThisAssembly.Metadata/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,7 @@ The metadata attribute can alternatively be declared using MSBuild syntax in the
</ItemGroup>
```

Set the `$(ThisAssemblyNamespace)` MSBuild property to set the root namespace of the
generated `ThisAssembly` class. Otherwise, it will be generated in the global namespace.

<!-- #metadata -->
<!-- include ../visibility.md -->
<!-- include https://github.com/devlooped/sponsors/raw/main/footer.md -->
<!-- exclude -->
4 changes: 1 addition & 3 deletions src/ThisAssembly.Project/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ them as `ProjectProperty` MSBuild items in the project file, such as:

![](https://raw.githubusercontent.com/devlooped/ThisAssembly/main/img/ThisAssembly.Project.png)

Set the `$(ThisAssemblyNamespace)` MSBuild property to set the root namespace of the
generated `ThisAssembly` class. Otherwise, it will be generated in the global namespace.

<!-- #project -->
<!-- include ../visibility.md -->
<!-- include https://github.com/devlooped/sponsors/raw/main/footer.md -->
<!-- exclude -->
4 changes: 1 addition & 3 deletions src/ThisAssembly.Resources/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,7 @@ treated as a text file:
You can also add a `Comment` item metadata attribute, which will be used as the `<summary>` XML
doc for the generated member.

Set the `$(ThisAssemblyNamespace)` MSBuild property to set the root namespace of the
generated `ThisAssembly` class. Otherwise, it will be generated in the global namespace.

<!-- #resources -->
<!-- include ../visibility.md -->
<!-- include https://github.com/devlooped/sponsors/raw/main/footer.md -->
<!-- exclude -->
4 changes: 1 addition & 3 deletions src/ThisAssembly.Strings/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,7 @@ partial class ThisAssembly
}
```

Set the `$(ThisAssemblyNamespace)` MSBuild property to set the root namespace of the
generated `ThisAssembly` class. Otherwise, it will be generated in the global namespace.

<!-- #strings -->
<!-- include ../visibility.md -->
<!-- include https://github.com/devlooped/sponsors/raw/main/footer.md -->
<!-- exclude -->
1 change: 1 addition & 0 deletions src/ThisAssembly/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,6 @@
## ThisAssembly.Strings
<!-- include ../ThisAssembly.Strings/readme.md#strings -->

<!-- include ../visibility.md -->
<!-- include https://github.com/devlooped/sponsors/raw/main/footer.md -->
<!-- exclude -->
16 changes: 16 additions & 0 deletions src/visibility.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Customizing the generated class

Set the `$(ThisAssemblyNamespace)` MSBuild property to set the namespace of the
generated `ThisAssembly` root class. Otherwise, it will be generated in the global namespace.

All generated classes are partial and have no visibility modifier, so they can be extended
manually with another partial that can add members or modify their visibility to make them
public, if needed. The C# default for this case is for all classes to be internal.

```csharp
// makes the generated classes public
public partial ThisAssembly
{
public partial class Constants { }
}
```

0 comments on commit c95ff1a

Please sign in to comment.