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

Fix api doc warning #9871

Merged
merged 3 commits into from
Apr 2, 2024
Merged

Fix api doc warning #9871

merged 3 commits into from
Apr 2, 2024

Conversation

JaynieBai
Copy link
Member

Fixes #9766

Context

There are some documentation issues we should fix: dotnet/msbuild-api-docs#39 (comment)

msbuild-api-docs/xml/Microsoft.Build.Construction/ProjectRootElement.xml
Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Build.Construction.ProjectRootElement.MarkDirty(System.String,System.String)'.

msbuild-api-docs/xml/Microsoft.Build.Framework.XamlTypes/BaseProperty.xml
Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'seealso' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

msbuild-api-docs/xml/Microsoft.Build.Framework/BuildEventArgs.xml
Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Build.Framework.BuildEventArgs.timestamp'.

msbuild-api-docs/xml/Microsoft.Build.Framework/CustomBuildEventArgs.xml
Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
Line 0, Column 0: [Warning: disallowed-html-tag - See documentation] HTML tag 'see' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.

Changes Made

Update the link

Copy link
Member

@MichalPavlik MichalPavlik left a comment

Choose a reason for hiding this comment

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

LGTM

@MichalPavlik MichalPavlik requested a review from ghogen March 15, 2024 09:19
src/Build/Construction/ProjectRootElement.cs Outdated Show resolved Hide resolved
@YuliiaKovalova YuliiaKovalova requested a review from rokonec March 27, 2024 11:18
Copy link
Member

@JanKrivanek JanKrivanek left a comment

Choose a reason for hiding this comment

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

Looks good - after the cref for ProjectRootElement.MarkDirty is removed.
Thanks!

@YuliiaKovalova YuliiaKovalova dismissed rokonec’s stale review April 2, 2024 11:29

the comment was addressed

@YuliiaKovalova YuliiaKovalova merged commit 66f095a into main Apr 2, 2024
9 checks passed
@YuliiaKovalova YuliiaKovalova deleted the dev/jenny/issue9766 branch April 2, 2024 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix documentation warnings
5 participants