search

planetarium / libplanet

Blockchain in C#/.NET for on-chain, decentralized gaming
https://docs.libplanet.io/
GNU Lesser General Public License v2.1
506 stars 142 forks source link

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

Closed moreal closed 1 year ago

moreal commented 2 years ago

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)
longfin commented 2 years ago

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

tkiapril commented 2 years ago

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)

moreal commented 2 years ago

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

OnedgeLee commented 2 years ago

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.

tkiapril commented 2 years ago

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. 🤔

stale[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity. Thank you for your contributions.