Another feature wish would be to support the
/// <inheritdoc /> or /// <inheritdoc cref="PsyPrax.PXModule.Demo.Interfaces.IPpDemoOttoWorkService.ChangeTester" />
Tag to copy the documentation from the interface documentation, when defined on the implementation method.
See: Recommended XML documentation tags - C# reference | Microsoft Learn
Regards,
Daniel
Documentation is automatically inherited from implemented/overridden members in DocInsight 3 (to be implemented in DocInsight 2024), this should meet common needs.
<inheitdoc> tag provides more customization capability and can be used in more scenarios. Consider support it in future (when designing new doc editor).
Well, then I have to say, at the moment it does not work. At least as I would expect it. I have a completely service oriented architecture and almost all of the interfaces and their members are documented, yet none of the implementing methods inherit the documentation.
However, there are way more places I would love to see the implementation of inheritdoc, which would help a lot of common scenarios, like event processing and such, where you have a method checking whether event handlers are registered to process those, or accessing messaging pipes relaying parameters, and so on.
Hi, it is listed in the tracking issue: Auto inherited documentation which is being in progress.
Yes. the tag is useful to reduce duplicated documentation.
See: Support `<inheritdoc>` tag · Issue #18 · devjetsoftware/docinsight-support · GitHub