Skip to content

[Java.Interop.Tools.JavaSource] Fix Javadoc based <cref/> generation #843

Open
@pjcollins

Description

@pjcollins

The following Javadoc tag to C# documentation element conversions are problematic when it comes to the generated <cref/>content:

  • @exception -> <exception/>
  • @throws -> <exception/>
  • @see -> <seealso/>
  • {@link} -> <c><see/></c>
  • {@linkplain} -> <see/>

In all cases, the "target" value we will parse from these Javadoc tags (and attempt to insert into a <cref/> attribute) will be a Java type. We need a way to convert this to the corresponding C# type.

There are some other issues with @see, {@link}, and {@linkplain} that need to be addressed to handle different forms of their occurrences or an option label value. We may be able to address some of these issues separately however.

Metadata

Metadata

Assignees

No one assigned

    Labels

    javadocIssues with consuming Java documentation formats

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions