[Java.Interop.Tools.JavaSource] Fix Javadoc based <cref/> generation
#843
Assignees
Comments
pjcollins
added a commit
to pjcollins/java.interop
that referenced
this issue
May 19, 2021
Context: dotnet#843 Context: xamarin/android-api-docs#23 A handful of "broken" Javadoc to C# Doc conversions have been disabled for now. This will hopefully help reduce the number of new warnings introduced by xamarin/android-api-docs#23, and allow us to get an initial major documentation update landed in the short term. Longer term, we will revisit and fix these Javadoc conversion issues. Additionally, `Javadoc.cs` has been removed from tools/generator as it appeared to be an unused partial duplicate of `JavadocInfo.cs`.
pjcollins
added a commit
to pjcollins/java.interop
that referenced
this issue
May 19, 2021
Context: dotnet#843 Context: xamarin/android-api-docs#23 A handful of "broken" Javadoc to C# Doc conversions have been disabled for now. This will hopefully help reduce the number of new warnings introduced by xamarin/android-api-docs#23, and allow us to get an initial major documentation update landed in the short term. Longer term, we will revisit and fix these Javadoc conversion issues. Additionally, `Javadoc.cs` has been removed from tools/generator as it appeared to be an unused partial duplicate of `JavadocInfo.cs`.
jpobst
added
bug
pjcollins
added a commit
to pjcollins/java.interop
that referenced
this issue
Oct 27, 2021
Context: dotnet#843 Context: xamarin/android-api-docs#23 A handful of "broken" Javadoc to C# Doc conversions have been disabled for now. This will hopefully help reduce the number of new warnings introduced by xamarin/android-api-docs#23, and allow us to get an initial major documentation update landed in the short term. Longer term, we will revisit and fix these Javadoc conversion issues. Additionally, `Javadoc.cs` has been removed from tools/generator as it appeared to be an unused partial duplicate of `JavadocInfo.cs`. Finally, the `<tt>` tag is no longer supported in our docs build: HTML tag 'tt' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. It has been replaced with `<code>` when generating Android Doc links.
jonpryor
pushed a commit
that referenced
this issue
Nov 8, 2021
) Context: #843 Context: xamarin/android-api-docs#23 A handful of "broken" Javadoc to C# Doc conversions have been disabled for now. This will hopefully help reduce the number of new warnings introduced by xamarin/android-api-docs#23, and allow us to get an initial major documentation update landed in the short term. Longer term, we will revisit and fix these Javadoc conversion issues. Additionally, `Javadoc.cs` has been removed from tools/generator as it appeared to be an unused partial duplicate of `JavadocInfo.cs`. Finally, the `<tt>` tag is no longer supported in our docs build: HTML tag 'tt' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. It has been replaced with `<code>` when generating Android Doc links.
pjcollins
added a commit
to pjcollins/java.interop
that referenced
this issue
Jan 4, 2022
Partially fixes: dotnet#907 Replaces `[TODO: @tag]` values in generated docs with `To be added` to better mirror mdoc behavior for missing elements. Inline `{@value }` tags that contain an argument have been updated to display the argument in a `<c/>` block. These should be fixed to use an appropriate CREF element in the future, see dotnet#843.
jonpryor
pushed a commit
that referenced
this issue
Jan 6, 2022
Context: #843 Context: #907 Replaces `[TODO: @tag]` values in generated docs with `To be added` to better mirror `mdoc` behavior for missing elements. Inline `{@value }` tags that contain an argument have been updated to display the argument in a `<c/>` block. These should be fixed to use an appropriate CREF in the future; see #843.
jpobst
added
javadoc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.The text was updated successfully, but these errors were encountered: