Skip to content

Commit cf92540

Browse files
authored
[tools] Enable xml doc generation for dotnet-linker. (#24950)
This way we get validation of any xml docs in dotnet-linker. Also make all warnings errors, since we're now warning-free.
1 parent 70916cd commit cf92540

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

src/Foundation/ExportAttribute.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636

3737
namespace Foundation {
3838

39+
#if !BUNDLER
3940
/// <summary>Exports a method or property to the Objective-C world.</summary>
4041
/// <remarks>
4142
/// <para>
@@ -52,6 +53,7 @@ namespace Foundation {
5253
/// ]]></code>
5354
/// </example>
5455
/// </remarks>
56+
#endif
5557
[AttributeUsage (AttributeTargets.Method | AttributeTargets.Constructor | AttributeTargets.Property)]
5658
public class ExportAttribute : Attribute {
5759
string? selector;

tools/common/StringUtils.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ public static Version ParseVersion (string v)
247247
/// <param name="code">The code of the message.</param>
248248
/// <param name="message">The message text.</param>
249249
/// <returns></returns>
250-
/// <see cref="https://learn.microsoft.com/visualstudio/msbuild/msbuild-diagnostic-format-for-tasks"/>
250+
/// <see href="https://learn.microsoft.com/visualstudio/msbuild/msbuild-diagnostic-format-for-tasks"/>
251251
public static string FormatMessage (string? fileName, long? lineNumber, bool isError, string prefix, int code, string message)
252252
{
253253
var sb = new StringBuilder ();

tools/dotnet-linker/dotnet-linker.csproj

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44
<RootNamespace>dotnet_linker</RootNamespace>
55
<DefineConstants>$(DefineConstants);BUNDLER</DefineConstants>
66
<AllowUnsafeBlocks>true</AllowUnsafeBlocks>
7-
<WarningsAsErrors>nullable</WarningsAsErrors>
7+
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
88
<AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
99
<Nullable>enable</Nullable>
10+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
11+
<NoWarn>$(NoWarn);CS1591</NoWarn> <!-- Missing XML comment for publicly visible type or member: don't care, the APIs aren't for public consumption -->
1012
</PropertyGroup>
1113

1214
<Import Project="..\..\eng\Versions.props" />

0 commit comments

Comments
 (0)