From c638d9f01cd7f610d0e74308346c3380dfa4bb86 Mon Sep 17 00:00:00 2001 From: Hossein Yousefi Date: Tue, 15 Oct 2024 01:53:04 +0200 Subject: [PATCH] Use singular name for doc and add dartdoc_options (#1657) --- pkgs/jnigen/dartdoc_options.yaml | 8 ++++++++ .../jnigen/{docs => doc}/interface_implementation.md | 12 ------------ pkgs/jnigen/{docs => doc}/java_differences.md | 0 3 files changed, 8 insertions(+), 12 deletions(-) create mode 100644 pkgs/jnigen/dartdoc_options.yaml rename pkgs/jnigen/{docs => doc}/interface_implementation.md (93%) rename pkgs/jnigen/{docs => doc}/java_differences.md (100%) diff --git a/pkgs/jnigen/dartdoc_options.yaml b/pkgs/jnigen/dartdoc_options.yaml new file mode 100644 index 000000000..1d3fb4798 --- /dev/null +++ b/pkgs/jnigen/dartdoc_options.yaml @@ -0,0 +1,8 @@ +dartdoc: + categories: + "Implementing Java interfaces from Dart": + markdown: doc/interface_implementation.md + name: "Interface Implementation" + "Syntactic and semantic differences between Java and the generated Dart bindings": + markdown: doc/java_differences.md + name: "Java Differences" diff --git a/pkgs/jnigen/docs/interface_implementation.md b/pkgs/jnigen/doc/interface_implementation.md similarity index 93% rename from pkgs/jnigen/docs/interface_implementation.md rename to pkgs/jnigen/doc/interface_implementation.md index 566824e78..0d23a5f2c 100644 --- a/pkgs/jnigen/docs/interface_implementation.md +++ b/pkgs/jnigen/doc/interface_implementation.md @@ -1,17 +1,5 @@ ## Implementing Java interfaces from Dart -> [!NOTE] -> This feature is experimental, and in -> [active development](https://github.com/dart-lang/native/issues/1569). -> -> To opt in to use this feature, add the following to your JNIgen configuration -> yaml: -> -> ```yaml -> enable_experiment: -> - interface_implementation -> ``` - Let's take a simple Java interface like `Runnable` that has a single `void` method called `run`: diff --git a/pkgs/jnigen/docs/java_differences.md b/pkgs/jnigen/doc/java_differences.md similarity index 100% rename from pkgs/jnigen/docs/java_differences.md rename to pkgs/jnigen/doc/java_differences.md