Skip to content

Bug: C# XML to JSDoc does not take see-cref into account #310

Description

@Lucasharskamp

Imagine we have a project where we export XML documentation to JSDoc, with the following code:

namespace Foo;

/// <summary>
/// Handles a collection of <see cref="FooBar" />s
/// </summary>
/// <param name="Items">Unique items present in the collection. </param>
[TsInterface]
public record Bar(List<FooBar> Items);

[TsInterface]
public record FooBar(int X);

That results in the following output:

module foo {

 /** Handles a collection of <see cref="T:Foo.FooBar" />s. */
	export interface IGetCountriesQueryResponse
	{
		/** Unique items present in the collection. */
		Items: foo.IFooBar[];
	}

	export interface IFooBar
	{
		x: number;
	}
}

Naturally, I'd want something like @link to show up, and not the original <see cref="..." />, or for the XML tag to be terminated and the final type mentioned in string format if not present as a generated entity. Other XML tags (paramref, etc) also need to be taken into account.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions