Skip to content

Fix api doc warning - #9871

Merged
YuliiaKovalova merged 3 commits into
mainfrom
dev/jenny/issue9766
Apr 2, 2024
Merged

Fix api doc warning#9871
YuliiaKovalova merged 3 commits into
mainfrom
dev/jenny/issue9766

Conversation

@JaynieBai

Copy link
Copy Markdown
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

@MichalPavlik MichalPavlik left a comment

Copy link
Copy Markdown
Member

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
Comment thread src/Build/Construction/ProjectRootElement.cs Outdated
@YuliiaKovalova
YuliiaKovalova requested a review from rokonec March 27, 2024 11:18

@JanKrivanek JanKrivanek left a comment

Copy link
Copy Markdown
Member

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
@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