Skip to content

Commit 107adbe

Browse files
authored
Merge pull request #1155 from Yoplitein/fix-docstrings-docs
`#[derive(GodotClass)]`, `#[godot_api]` docs: replace table of contents with sidebar
2 parents 4a6f803 + 8ebf376 commit 107adbe

File tree

1 file changed

+4
-27
lines changed

1 file changed

+4
-27
lines changed

godot-macros/src/lib.rs

Lines changed: 4 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -35,19 +35,7 @@ use crate::util::{bail, ident, KvParser};
3535
///
3636
/// See also [book chapter _Registering classes_](https://godot-rust.github.io/book/register/classes.html).
3737
///
38-
/// **Table of contents:**
39-
/// - [Construction](#construction)
40-
/// - [Inheritance](#inheritance)
41-
/// - [Properties and exports](#properties-and-exports)
42-
/// - [Property registration](#property-registration)
43-
/// - [Property exports](#property-exports)
44-
/// - [Further class customization](#further-class-customization)
45-
/// - [Running code in the editor](#running-code-in-the-editor)
46-
/// - [Editor plugins](#editor-plugins)
47-
/// - [Class renaming](#class-renaming)
48-
/// - [Class hiding](#class-hiding)
49-
/// - [Further field customization](#further-field-customization)
50-
/// - [Fine-grained inference hints](#fine-grained-inference-hints)
38+
/// **See sidebar on the left for table of contents.**
5139
///
5240
///
5341
/// # Construction
@@ -426,11 +414,11 @@ use crate::util::{bail, ident, KvParser};
426414
/// # }
427415
/// ```
428416
///
417+
/// # Documentation
418+
///
429419
/// <div class="stab portability">Available on <strong>crate feature <code>register-docs</code></strong> only.</div>
430420
/// <div class="stab portability">Available on <strong>Godot version <code>4.3+</code></strong> only.</div>
431421
///
432-
/// # Documentation
433-
///
434422
/// You can document your functions, classes, members, and signals with the `///` doc comment syntax.
435423
///
436424
/// ```no_run
@@ -504,18 +492,7 @@ pub fn derive_godot_class(input: TokenStream) -> TokenStream {
504492
///
505493
/// See also [book chapter _Registering functions_](https://godot-rust.github.io/book/register/functions.html) and following.
506494
///
507-
/// **Table of contents**
508-
/// - [Constructors](#constructors)
509-
/// - [User-defined `init`](#user-defined-init)
510-
/// - [Generated `init`](#generated-init)
511-
/// - [Lifecycle functions](#lifecycle-functions)
512-
/// - [User-defined functions](#user-defined-functions)
513-
/// - [Associated functions and methods](#associated-functions-and-methods)
514-
/// - [Virtual methods](#virtual-methods)
515-
/// - [RPC attributes](#rpc-attributes)
516-
/// - [Signals](#signals)
517-
/// - [Constants](#constants)
518-
/// - [Multiple inherent `impl` blocks](#multiple-inherent-impl-blocks)
495+
/// **See sidebar on the left for table of contents.**
519496
///
520497
/// # Constructors
521498
///

0 commit comments

Comments
 (0)