Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract Maps, Graphics & Foldable docs during build #10909

Merged
merged 9 commits into from
Nov 7, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions eng/cake/dotnet.cake
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,7 @@ Task("dotnet-pack-docs")
EnsureDirectoryExists(destDir);
CleanDirectories(destDir);

// Get the docs for .NET MAUI
foreach (var nupkg in GetFiles("./artifacts/Microsoft.Maui.*.Ref.*.nupkg"))
{
var d = $"{tempDir}/{nupkg.GetFilename()}";
Expand All @@ -330,6 +331,20 @@ Task("dotnet-pack-docs")
CopyDirectory($"{d}/ref", $"{destDir}");
}

// Get the docs for libraries separately distributed as NuGets
foreach (var pattern in NuGetOnlyPackages)
{
foreach (var nupkg in GetFiles($"./artifacts/{pattern}"))
{
var d = $"{tempDir}/{nupkg.GetFilename()}";
Unzip(nupkg, d);
DeleteFiles($"{d}/**/*.pri");
DeleteFiles($"{d}/**/*.aar");
DeleteFiles($"{d}/**/*.pdb");
CopyDirectory($"{d}/lib", $"{destDir}");
}
}

CleanDirectories(tempDir);
});

Expand Down
2 changes: 2 additions & 0 deletions src/Controls/Foldable/src/Controls.Foldable.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
<RootNamespace>Microsoft.Maui.Controls.Foldable</RootNamespace>
<WarningsNotAsErrors>BI1234</WarningsNotAsErrors>
<IsPackable>true</IsPackable>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);CS1591</NoWarn>
<!-- TODO: remove this when Foldable is made into a nupkg -->
<UseMaui Condition=" '$(UseWorkload)' == 'true' ">true</UseMaui>
</PropertyGroup>
Expand Down
2 changes: 2 additions & 0 deletions src/Graphics/src/Graphics.Skia/Graphics.Skia.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
<TargetFrameworks>netstandard2.1;netstandard2.0;$(_MauiDotNetTfm);$(MauiGraphicsPlatforms)</TargetFrameworks>
<RootNamespace>Microsoft.Maui.Graphics.Skia</RootNamespace>
<AssemblyName>Microsoft.Maui.Graphics.Skia</AssemblyName>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);CS1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
2 changes: 2 additions & 0 deletions src/Graphics/src/Text.Markdig/Graphics.Text.Markdig.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
<TargetFramework>netstandard2.0</TargetFramework>
<RootNamespace>Microsoft.Maui.Graphics.Text</RootNamespace>
<AssemblyName>Microsoft.Maui.Graphics.Text.Markdig</AssemblyName>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);CS1591</NoWarn>
</PropertyGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ namespace Microsoft.Maui.Graphics.Text.Renderer
/// <summary>
/// A HTML renderer for a <see cref="ParagraphBlock"/>.
/// </summary>
/// <seealso cref="Markdig.Renderers.Html.HtmlObjectRenderer{Markdig.Syntax.ParagraphBlock}" />
/// <seealso cref="Markdig.Renderers.Html.HtmlObjectRenderer{ParagraphBlock}"/>
public class ParagraphRenderer : AttributedTextObjectRenderer<ParagraphBlock>
{
protected override void Write(AttributedTextRenderer renderer, ParagraphBlock obj)
Expand Down