Skip to content

replaced cref="..." with cref="@...` - #5623

Closed
eaba wants to merge 2 commits into
akkadotnet:devfrom
eaba:invalid_crefs
Closed

eaba wants to merge 2 commits into
akkadotnet:devfrom
eaba:invalid_crefs

Conversation

@eaba

@eaba eaba commented Feb 10, 2022

Copy link
Copy Markdown
Contributor

Part fix for #5542

@Aaronontheweb

This log shows warnings about Invalid cref value "!:xxxxxxx" found in triple-slash-comments.... which I have not been able to reproduce locally. Locally the warnings are down to 201 with majority of the WARNINGS being Could not resolve base documentation for.

I found this comment interesting dotnet/docfx#5112 (comment) @Arkatufus

Comment thread output.txt Outdated
@@ -0,0 +1,2497 @@

C:\Users\Ebere\source\repos\akka.net>PowerShell.exe -file "build.ps1" docfx --warningsAsErrors

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.

Need to remove this

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.

i.e. the entire file needs to be deleted

@Aaronontheweb

Copy link
Copy Markdown
Member

I just found out you can disable these CREF warnings via #pragma warning disable CS0419 // Ambiguous reference in cref attribute while reviewing #4629 - that might be helpful in some instances where the cref is actually useful but can't be resolved.

@Aaronontheweb

Copy link
Copy Markdown
Member

@eaba that comment is interesting - maybe we need to modify the DocFx build step in FAKE to do buildRelease first THEN compile the documentation? Give that a try?

@eaba

eaba commented Feb 10, 2022

Copy link
Copy Markdown
Contributor Author

@eaba that comment is interesting - maybe we need to modify the DocFx build step in FAKE to do buildRelease first THEN compile the documentation? Give that a try?

I think @Arkatufus should look into how #5542 uses docfx. Because on my machine, the warning are not there!

Right now the only way forward is to work with the warnings I got from running build.cmd docfx locally.

@Aaronontheweb

Copy link
Copy Markdown
Member

@eaba that comment is interesting - maybe we need to modify the DocFx build step in FAKE to do buildRelease first THEN compile the documentation? Give that a try?

I think @Arkatufus should look into how #5542 uses docfx. Because on my machine, the warning are not there!

Right now the only way forward is to work with the warnings I got from running build.cmd docfx locally.

You can look at the PR and see what he's doing there

@Aaronontheweb

Copy link
Copy Markdown
Member

No longer needed as a result of DocFx build changes per @eaba

@eaba
eaba deleted the invalid_crefs branch February 13, 2022 17:18
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.

2 participants