Browse Source

feat(macros): hide command macro from docs, closes #4550 (#4556)

Lucas Fernandes Nogueira 3 years ago
parent
commit
d4cdf80781

+ 5 - 0
.changes/doc-hide-command-macro.md

@@ -0,0 +1,5 @@
+---
+"tauri-macros": patch
+---
+
+Add `#[doc(hidden)]` attribute to the `#[command]` generated macro.

+ 1 - 0
core/tauri-macros/src/command/wrapper.rs

@@ -78,6 +78,7 @@ pub fn wrapper(attributes: TokenStream, item: TokenStream) -> TokenStream {
     #function
 
     #maybe_macro_export
+    #[doc(hidden)]
     macro_rules! #wrapper {
         // double braces because the item is expected to be a block expression
         ($path:path, $invoke:ident) => {{

+ 7 - 7
examples/api/src-tauri/Cargo.lock

@@ -3130,7 +3130,7 @@ dependencies = [
 
 [[package]]
 name = "tauri"
-version = "1.0.1"
+version = "1.0.2"
 dependencies = [
  "anyhow",
  "attohttpc",
@@ -3192,7 +3192,7 @@ dependencies = [
 
 [[package]]
 name = "tauri-build"
-version = "1.0.1"
+version = "1.0.2"
 dependencies = [
  "anyhow",
  "cargo_toml",
@@ -3206,7 +3206,7 @@ dependencies = [
 
 [[package]]
 name = "tauri-codegen"
-version = "1.0.1"
+version = "1.0.2"
 dependencies = [
  "base64",
  "brotli",
@@ -3229,7 +3229,7 @@ dependencies = [
 
 [[package]]
 name = "tauri-macros"
-version = "1.0.1"
+version = "1.0.2"
 dependencies = [
  "heck 0.4.0",
  "proc-macro2",
@@ -3241,7 +3241,7 @@ dependencies = [
 
 [[package]]
 name = "tauri-runtime"
-version = "0.10.0"
+version = "0.10.1"
 dependencies = [
  "gtk",
  "http",
@@ -3259,7 +3259,7 @@ dependencies = [
 
 [[package]]
 name = "tauri-runtime-wry"
-version = "0.10.0"
+version = "0.10.1"
 dependencies = [
  "cocoa",
  "gtk",
@@ -3277,7 +3277,7 @@ dependencies = [
 
 [[package]]
 name = "tauri-utils"
-version = "1.0.1"
+version = "1.0.2"
 dependencies = [
  "aes-gcm",
  "brotli",