FsAutoComplete icon indicating copy to clipboard operation
FsAutoComplete copied to clipboard

`inheritdoc` entries are not followed and resolved in our tooltips/documentation

Open baronfel opened this issue 5 months ago • 0 comments

Details

The StreamJsonRpc.JsonRpcTargetOptions.UseSingleObjectParameterDeserialization property (and several others on this type) make use of <inheritdoc cref="some_other_member"> to reuse xmldoc. This looks like this in the generated xmldoc:

<member name="P:StreamJsonRpc.JsonRpcTargetOptions.UseSingleObjectParameterDeserialization">
  <inheritdoc cref="P:StreamJsonRpc.JsonRpcMethodAttribute.UseSingleObjectParameterDeserialization" />
  <remarks>
      This value serves as a default for <see cref="P:StreamJsonRpc.JsonRpcMethodAttribute.UseSingleObjectParameterDeserialization"/> for members that have no <see cref="T:StreamJsonRpc.JsonRpcMethodAttribute"/> applied.
  </remarks>
</member>

In Ionide, we don't render this in the tooltips and info panel:

Tooltips:

Image

Info Panel:

Image

We need to be able to follow the cref inside this element and merge the docs from one member into another.

Checklist

  • [x] I have looked through existing issues to make sure that this feature has not been requested before
  • [x] I have provided a descriptive title for this issue
  • [x] I am aware that even valid feature requests may be rejected if they do not align with the project's goals
  • [x] I or my company would be willing to contribute this feature

baronfel avatar Sep 14 '25 21:09 baronfel