Skip to content

Invalid markdown link syntax for see cref #19

@AmadeusW

Description

@AmadeusW

The TagRenderer for see cref constructs the following markdown format: [[{1}|{0}]]
This doesn't seem to be a valid link under any markdown specification.
Looking deeper into this, this is a format for seePage. Valid format [{1}]({0}) exists for seeAnchor, but it is used only if the reference name in XML starts with !:#

Am I missing something about the markdown specification or doc comments?
Would you accept a PR that generates universally working markdown fora a doc comment like below?


  • Original doc comment
    /// <summary>
    /// This struct is used to transfer data from <see cref="Class1"/> to <see cref="Class2"/>
    /// </summary>
  • generated XML file
            <summary>
            This struct is used to transfer data from <see cref="T:MyNamespace.Class1"/>
            to <see cref="T:MyNamespace.Class2"/>
            </summary>
  • Current output of the tool
 This struct is used to transfer data from [[| T:MyNamespace.Class1]] to [[|T:MyNamespace.Class2]] 
  • Current output of the tool renders as
    This struct is used to transfer data from [[| T:MyNamespace.Class1]] to [[|T:MyNamespace.Class2]]

  • Proposed output of the tool

 This struct is used to transfer data from [Class1](#MyNamespace.Class1) to [Class2](#MyNamespace.Class2) 
  • Proposed output of the tool would render as
    This struct is used to transfer data from Class1 to Class2

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions