Rename java.generate_native_headers to java.native_headers

This follows the Meson naming scheme which typically leaves off a verb
like generate.

1 files changed, 44 insertions, 0 deletions

diff --git a/docs/markdown/Java-module.md b/docs/markdown/Java-module.md
index 54438e2..aa95f78 100644
--- a/docs/markdown/Java-module.md
+++ b/docs/markdown/Java-module.md
@@ -20,6 +20,50 @@ file. If left empty, Meson will assume that there is no package.
 ### `generate_native_headers()`
 
 *(added in 0.62.0)*
+*(deprecated in 1.0.0, use `native_headers()`)*
+
+This function will generate native header files for use in Java native module
+development by reading the supplied Java files for `native` method declarations.
+
+Keyword arguments:
+
+- `classes`: The list of class names relative to the `package`, if it exists,
+which contain `native` method declarations. Use `.` separated class names.
+
+- `package`: The [package](https://en.wikipedia.org/wiki/Java_package) of the
+file. If left empty, Meson will assume that there is no package.
+
+Example:
+
+```java
+// Outer.java
+
+package com.mesonbuild;
+
+public class Outer {
+    private static native void outer();
+
+    public static class Inner {
+        private static native void inner();
+    }
+}
+```
+
+With the above file, an invocation would look like the following:
+
+```meson
+java = import('java')
+
+native_headers = java.generate_native_headers(
+    'Outer.java',
+    package: 'com.mesonbuild',
+    classes: ['Outer', 'Outer.Inner']
+)
+```
+
+### `native_headers()`
+
+*(added in 1.0.0)*
 
 This function will generate native header files for use in Java native module
 development by reading the supplied Java files for `native` method declarations.