Correctly escape comments that may contain tags

pkgs/jnigen/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.10.1
+
+- Add backticks to code references in doc comments.
+
 ## 0.10.0
 
 - Added support for Kotlin's top-level functions and fields.

pkgs/jnigen/README.md

@@ -83,7 +83,7 @@ class AndroidUtils extends jni.JObject {
           jni.JThrowablePtr Function(ffi.Pointer<ffi.Void>, jni.JMethodIDPtr,
               ffi.Pointer<ffi.Void>, ffi.Pointer<ffi.Void>, int)>();
 
-  /// from: static public void showToast(android.app.Activity mainActivity, java.lang.CharSequence text, int duration)
+  /// from: `static public void showToast(android.app.Activity mainActivity, java.lang.CharSequence text, int duration)`
   static void showToast(
     jni.JObject mainActivity,
     jni.JObject text,

pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocument.dart

@@ -48,7 +48,7 @@ import 'package:jni/jni.dart' as jni;
 
 import 'PDDocumentInformation.dart' as pddocumentinformation_;
 
-/// from: org.apache.pdfbox.pdmodel.PDDocument
+/// from: `org.apache.pdfbox.pdmodel.PDDocument`
 ///
 /// This is the in-memory representation of the PDF document.
 /// The \#close() method must be called once the document is no longer needed.

pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/pdmodel/PDDocumentInformation.dart

@@ -46,7 +46,7 @@ import 'dart:isolate' show ReceivePort;
 import 'package:jni/internal_helpers_for_jnigen.dart';
 import 'package:jni/jni.dart' as jni;
 
-/// from: org.apache.pdfbox.pdmodel.PDDocumentInformation
+/// from: `org.apache.pdfbox.pdmodel.PDDocumentInformation`
 ///
 /// This is the document metadata.  Each getXXX method will return the entry if
 /// it exists or null if it does not exist.  If you pass in null for the setXXX

pkgs/jnigen/example/pdfbox_plugin/lib/src/third_party/org/apache/pdfbox/text/PDFTextStripper.dart

@@ -48,7 +48,7 @@ import 'package:jni/jni.dart' as jni;
 
 import '../pdmodel/PDDocument.dart' as pddocument_;
 
-/// from: org.apache.pdfbox.text.PDFTextStripper
+/// from: `org.apache.pdfbox.text.PDFTextStripper`
 ///
 /// This class will take a pdf document and strip out all of the text and ignore the formatting and such. Please note; it
 /// is up to clients of this class to verify that a specific user has the correct permissions to extract text from the
@@ -75,7 +75,7 @@ class PDFTextStripper extends jni.JObject {
     r'Ljava/lang/String;',
   );
 
-  /// from: protected final java.lang.String LINE_SEPARATOR
+  /// from: `protected final java.lang.String LINE_SEPARATOR`
   /// The returned object must be released after use, by calling the [release] method.
   ///
   /// The platform's line separator.
@@ -87,7 +87,7 @@ class PDFTextStripper extends jni.JObject {
     r'Ljava/util/ArrayList;',
   );
 
-  /// from: protected java.util.ArrayList<java.util.List<org.apache.pdfbox.text.TextPosition>> charactersByArticle
+  /// from: `protected java.util.ArrayList<java.util.List<org.apache.pdfbox.text.TextPosition>> charactersByArticle`
   /// The returned object must be released after use, by calling the [release] method.
   ///
   /// The charactersByArticle is used to extract text by article divisions. For example a PDF that has two columns like
@@ -105,7 +105,7 @@ class PDFTextStripper extends jni.JObject {
   jni.JObject get charactersByArticle =>
       _id_charactersByArticle.get(this, const jni.JObjectType());
 
-  /// from: protected java.util.ArrayList<java.util.List<org.apache.pdfbox.text.TextPosition>> charactersByArticle
+  /// from: `protected java.util.ArrayList<java.util.List<org.apache.pdfbox.text.TextPosition>> charactersByArticle`
   /// The returned object must be released after use, by calling the [release] method.
   ///
   /// The charactersByArticle is used to extract text by article divisions. For example a PDF that has two columns like
@@ -128,12 +128,12 @@ class PDFTextStripper extends jni.JObject {
     r'Lorg/apache/pdfbox/pdmodel/PDDocument;',
   );
 
-  /// from: protected org.apache.pdfbox.pdmodel.PDDocument document
+  /// from: `protected org.apache.pdfbox.pdmodel.PDDocument document`
   /// The returned object must be released after use, by calling the [release] method.
   pddocument_.PDDocument get document =>
       _id_document.get(this, const pddocument_.$PDDocumentType());
 
-  /// from: protected org.apache.pdfbox.pdmodel.PDDocument document
+  /// from: `protected org.apache.pdfbox.pdmodel.PDDocument document`
   /// The returned object must be released after use, by calling the [release] method.
   set document(pddocument_.PDDocument value) =>
       _id_document.set(this, const pddocument_.$PDDocumentType(), value);
@@ -143,11 +143,11 @@ class PDFTextStripper extends jni.JObject {
     r'Ljava/io/Writer;',
   );
 
-  /// from: protected java.io.Writer output
+  /// from: `protected java.io.Writer output`
   /// The returned object must be released after use, by calling the [release] method.
   jni.JObject get output => _id_output.get(this, const jni.JObjectType());
 
-  /// from: protected java.io.Writer output
+  /// from: `protected java.io.Writer output`
   /// The returned object must be released after use, by calling the [release] method.
   set output(jni.JObject value) =>
       _id_output.set(this, const jni.JObjectType(), value);

pkgs/jnigen/lib/src/bindings/dart_generator.dart

@@ -304,7 +304,7 @@ ${modifier}final $classRef = $_jni.JClass.forName(r'$internalName');
       return;
     }
     // Docs.
-    s.write('/// from: ${node.binaryName}\n');
+    s.write('/// from: `${node.binaryName}`\n');
     node.javadoc?.accept(_DocGenerator(s, depth: 0));
 
     // Class definition.
@@ -956,7 +956,7 @@ ${modifier}final _id_$name =
 
   void writeDocs(Field node, {required bool writeReleaseInstructions}) {
     final originalDecl = '${node.type.shorthand} ${node.name}';
-    s.writeln('  /// from: ${node.modifiers.join(' ')} $originalDecl');
+    s.writeln('  /// from: `${node.modifiers.join(' ')} $originalDecl`');
     if (node.type.kind != Kind.primitive && writeReleaseInstructions) {
       s.writeln(_releaseInstruction);
     }

pkgs/jnigen/pubspec.yaml

@@ -4,7 +4,7 @@
 
 name: jnigen
 description: A Dart bindings generator for Java and Kotlin that uses JNI under the hood to interop with Java virtual machine.
-version: 0.10.0
+version: 0.10.1
 repository: https://github.com/dart-lang/native/tree/main/pkgs/jnigen
 
 environment:

pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/JsonFactory.dart

@@ -47,7 +47,7 @@ import 'package:jni/jni.dart' as jni;
 
 import 'JsonParser.dart' as jsonparser_;
 
-/// from: com.fasterxml.jackson.core.JsonFactory$Feature
+/// from: `com.fasterxml.jackson.core.JsonFactory$Feature`
 ///
 /// Enumeration that defines all on/off features that can only be
 /// changed for JsonFactory.
@@ -237,7 +237,7 @@ final class $JsonFactory_FeatureType extends jni.JObjType<JsonFactory_Feature> {
   }
 }
 
-/// from: com.fasterxml.jackson.core.JsonFactory
+/// from: `com.fasterxml.jackson.core.JsonFactory`
 ///
 /// The main factory class of Jackson package, used to configure and
 /// construct reader (aka parser, JsonParser)
@@ -274,7 +274,7 @@ class JsonFactory extends jni.JObject {
     r'Ljava/lang/String;',
   );
 
-  /// from: static public final java.lang.String FORMAT_NAME_JSON
+  /// from: `static public final java.lang.String FORMAT_NAME_JSON`
   /// The returned object must be released after use, by calling the [release] method.
   ///
   /// Name used to identify JSON format
@@ -287,7 +287,7 @@ class JsonFactory extends jni.JObject {
     r'I',
   );
 
-  /// from: static protected final int DEFAULT_FACTORY_FEATURE_FLAGS
+  /// from: `static protected final int DEFAULT_FACTORY_FEATURE_FLAGS`
   ///
   /// Bitfield (set of flags) of all factory features that are enabled by default.
   static int get DEFAULT_FACTORY_FEATURE_FLAGS =>
@@ -298,7 +298,7 @@ class JsonFactory extends jni.JObject {
     r'I',
   );
 
-  /// from: static protected final int DEFAULT_PARSER_FEATURE_FLAGS
+  /// from: `static protected final int DEFAULT_PARSER_FEATURE_FLAGS`
   ///
   /// Bitfield (set of flags) of all parser features that are enabled
   /// by default.
@@ -310,7 +310,7 @@ class JsonFactory extends jni.JObject {
     r'I',
   );
 
-  /// from: static protected final int DEFAULT_GENERATOR_FEATURE_FLAGS
+  /// from: `static protected final int DEFAULT_GENERATOR_FEATURE_FLAGS`
   ///
   /// Bitfield (set of flags) of all generator features that are enabled
   /// by default.
@@ -322,7 +322,7 @@ class JsonFactory extends jni.JObject {
     r'Lcom/fasterxml/jackson/core/SerializableString;',
   );
 
-  /// from: static public final com.fasterxml.jackson.core.SerializableString DEFAULT_ROOT_VALUE_SEPARATOR
+  /// from: `static public final com.fasterxml.jackson.core.SerializableString DEFAULT_ROOT_VALUE_SEPARATOR`
   /// The returned object must be released after use, by calling the [release] method.
   static jni.JObject get DEFAULT_ROOT_VALUE_SEPARATOR =>
       _id_DEFAULT_ROOT_VALUE_SEPARATOR.get(_class, const jni.JObjectType());

pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/JsonParser.dart

@@ -47,7 +47,7 @@ import 'package:jni/jni.dart' as jni;
 
 import 'JsonToken.dart' as jsontoken_;
 
-/// from: com.fasterxml.jackson.core.JsonParser$Feature
+/// from: `com.fasterxml.jackson.core.JsonParser$Feature`
 ///
 /// Enumeration that defines all on/off features for parsers.
 class JsonParser_Feature extends jni.JObject {
@@ -236,7 +236,7 @@ final class $JsonParser_FeatureType extends jni.JObjType<JsonParser_Feature> {
   }
 }
 
-/// from: com.fasterxml.jackson.core.JsonParser$NumberType
+/// from: `com.fasterxml.jackson.core.JsonParser$NumberType`
 ///
 /// Enumeration of possible "native" (optimal) types that can be
 /// used for numbers.
@@ -331,7 +331,7 @@ final class $JsonParser_NumberTypeType
   }
 }
 
-/// from: com.fasterxml.jackson.core.JsonParser
+/// from: `com.fasterxml.jackson.core.JsonParser`
 ///
 /// Base class that defines public API for reading JSON content.
 /// Instances are created using factory methods of
@@ -355,7 +355,7 @@ class JsonParser extends jni.JObject {
     r'Lcom/fasterxml/jackson/core/util/JacksonFeatureSet;',
   );
 
-  /// from: static protected final com.fasterxml.jackson.core.util.JacksonFeatureSet<com.fasterxml.jackson.core.StreamReadCapability> DEFAULT_READ_CAPABILITIES
+  /// from: `static protected final com.fasterxml.jackson.core.util.JacksonFeatureSet<com.fasterxml.jackson.core.StreamReadCapability> DEFAULT_READ_CAPABILITIES`
   /// The returned object must be released after use, by calling the [release] method.
   ///
   /// Default set of StreamReadCapabilityies that may be used as

pkgs/jnigen/test/jackson_core_test/third_party/bindings/com/fasterxml/jackson/core/JsonToken.dart

@@ -45,7 +45,7 @@ import 'dart:isolate' show ReceivePort;
 import 'package:jni/internal_helpers_for_jnigen.dart';
 import 'package:jni/jni.dart' as jni;
 
-/// from: com.fasterxml.jackson.core.JsonToken
+/// from: `com.fasterxml.jackson.core.JsonToken`
 ///
 /// Enumeration for basic token types used for returning results
 /// of parsing JSON content.

pkgs/jnigen/test/kotlin_test/bindings/kotlin.dart

@@ -32,7 +32,7 @@ import 'dart:isolate' show ReceivePort;
 import 'package:jni/internal_helpers_for_jnigen.dart';
 import 'package:jni/jni.dart' as jni;
 
-/// from: com.github.dart_lang.jnigen.SuspendFun
+/// from: `com.github.dart_lang.jnigen.SuspendFun`
 class SuspendFun extends jni.JObject {
   @override
   late final jni.JObjType<SuspendFun> $type = type;