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

Set GenerateDocumentationFile=true for MAUI Essentials #6907

Merged
merged 1 commit into from
May 7, 2022

Conversation

Eilon
Copy link
Member

@Eilon Eilon commented May 6, 2022

Description of Change

Similar to #6874, this enables XML doc comments for MAUI Essentials, which also has a ton of XML docs, but they're not published.

Issues Fixed

Partial fix for #5341

@Eilon Eilon requested review from Redth, hartez and mattleibow May 6, 2022 22:02
@@ -8,6 +8,8 @@
<NoWarn>$(NoWarn);CA1416</NoWarn>
<IsPackable>false</IsPackable>
<IsTrimmable>true</IsTrimmable>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<NoWarn>$(NoWarn);CS1591</NoWarn>
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as before: Need to ignore missing doc comments (for now, anyway).

@@ -180,7 +180,7 @@ public ShareMultipleFilesRequest()
{
}

/// <include file="../../docs/Microsoft.Maui.Essentials/ShareMultipleFilesRequest.xml" path="//Member[@MemberName='.ctor'][1]/Docs" />
/// <include file="../../docs/Microsoft.Maui.Essentials/ShareMultipleFilesRequest.xml" path="//Member[@MemberName='.ctor'][3]/Docs" />
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The various scripts we previously used to import existing docs often got things mixed up with overloads. This fixes such mix-ups by selecting the correct overload.

@Eilon Eilon added the area-docs Conceptual docs, API docs, Samples label May 6, 2022
@mattleibow mattleibow merged commit 1cf230b into main May 7, 2022
@mattleibow mattleibow deleted the eilon/essentials-xml-docs branch May 7, 2022 08:35
@github-actions github-actions bot locked and limited conversation to collaborators Dec 22, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-docs Conceptual docs, API docs, Samples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants