libplanet icon indicating copy to clipboard operation
libplanet copied to clipboard

Apparently `cref`s to other than Libplanet.dll are not resolved

Open moreal opened this issue 3 years ago • 5 comments

When you see the part of the document, you can see the exceptions' link like InvalidOperationException or KeyNotFoundException.

Examples

  1. IAccountStateDelta (docs, code)
  2. IStore.PruneOutdatedChains (docs, code)

moreal avatar Jul 29 '22 03:07 moreal

@moreal Could you give more detailed info or the screen capture about the symptom you said? (I couldn't get the point 😅 )

longfin avatar Jul 29 '22 12:07 longfin

I think it's that on the XML there is a reference to exceptions: image but once it's compiled it vanishes: image (notice the lack of KeyNotFoundException)

tkiapril avatar Jul 29 '22 12:07 tkiapril

That's what I mean, if the title made you confused, it should be corrected 😓

moreal avatar Jul 29 '22 14:07 moreal

Since our document does not have referenced exception type, it cannot be seen on document. It would be better to use tag, or link MS official document.

OnedgeLee avatar Aug 21 '22 02:08 OnedgeLee

This may have occurred due to a MSBuild bug, refer https://github.com/dotnet/docfx/issues/8097 and https://github.com/dotnet/msbuild/issues/7832. Not sure if it's suitable as a good first issue. 🤔

tkiapril avatar Aug 29 '22 11:08 tkiapril