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

Deal with XMLDOC references to mscorlib #4

Open
zsr2531 opened this issue Feb 8, 2022 · 0 comments
Open

Deal with XMLDOC references to mscorlib #4

zsr2531 opened this issue Feb 8, 2022 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@zsr2531
Copy link
Owner

zsr2531 commented Feb 8, 2022

An extremely common scenario when it comes to the <inheritdoc /> tag is when the user would like to inherit documentation from mscorlib (ie. Equals, ToString, GetHashCode, etc.). Since this is very common, an extra XMLDOC path shouldn't need to be provided by the user and Doktr should implicitly include it. This raises a couple of issues however:

  • Where to store the XML file? As a resource? Just a normal file that you should "carry" around with Doktr?
  • The XML file is pretty big. I haven't done any testing as of yet but I imagine that it will take a considerable amount of time to fully parse even when most of it probably won't be needed. This has the potential to slow Doktr down considerably.
@zsr2531 zsr2531 added enhancement New feature or request help wanted Extra attention is needed labels Feb 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant