Support @see

[steffen-wilke]

Currently, the doclet doesn't provide support for the @see documentation tag. It would be great if it could produce a section with a list of links from these tags below the documentation similar to {@link ...} tags.
Example Input

/**
 * {DOCUMENTATION}
 * ....
 * @see SomeClass#someMethod()
 * @see SomeOtherClass
 */

Example Output:

{DOCUMENTATION}
....
See also SomeClass.someMethod(), SomeOtherClass

[andrei-punko]

To make this feature available - may be some changes need to be applied from the DocFX side too, not only on doclet side (to get section 'see also'). So question (to DocFX developers @dendeli-msft @superyyrrzz ) is - what we want to see in generated .yml files when @see tags are present in source code?

[superyyrrzz]

This looks like the <seealso> in C#, which is already supported.

Sample:

• Source code: https://github.com/docascode/docfx-seed/blob/eea1fd7dc62e043cc59a28ab0ed11937161d38ab/src/SampleClass1/CatLibrary/Class1.cs#L399
• YAML: https://github.com/qinezh/op-docfx-seed/blob/e37574aea9113a812dea2b61f12b334bc394a5a6/api_ref/MRef.Demo.Enumeration.ColorType.yml#L36-L38
• Page: http://docascode.github.io/docfx-seed/api/MRef.Demo.Enumeration.ColorType.html

[andrei-punko]

Thanks, @superyyrrzz , seems doclet should generate seealso block with linkId and commentId inside it.
The linkId should contain uid of item.
But what about commentId field - is it mandatory? If so - what requirements about its content?

[superyyrrzz]

@v-anpunko commentId is a .NET specific concept, so linkId is enough.