Skip to content

Commit abd134f

Browse files
committed
Document modules object + nativescript
1 parent 2af44b7 commit abd134f

File tree

2 files changed

+20
-4
lines changed

2 files changed

+20
-4
lines changed

gdnative-core/src/nativescript/mod.rs

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,23 @@
1-
//! Types and functions related to the NativeScript extension of GDNative.
1+
//! Functionality for user-defined types exported to the engine (native scripts)
2+
//!
3+
//! NativeScript allows users to have their own scripts in a native language (in this case Rust).
4+
//! It is _not_ the same as GDNative, the native interface to call into Godot.
5+
//!
6+
//! Symbols in this module allow registration, exporting and management of user-defined types
7+
//! which are wrapped in native scripts.
8+
//!
9+
//! If you are looking for how to manage Godot core types or classes (objects), check
10+
//! out the [`core_types`][crate::core_types] and [`object`][crate::object] modules, respectively.
211
3-
pub(crate) mod class_registry;
12+
mod class;
413
mod emplace;
514
mod macros;
615

7-
mod class;
16+
pub(crate) mod class_registry;
17+
pub(crate) mod type_tag;
18+
819
pub mod init;
920
pub mod profiling;
10-
pub mod type_tag;
1121
pub mod user_data;
1222

1323
pub use class::*;

gdnative-core/src/object/mod.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
11
//! Provides types to interact with the Godot `Object` class hierarchy
2+
//!
3+
//! This module contains wrappers and helpers to interact with Godot objects.
4+
//! In Godot, classes stand in an inheritance relationship, with the root at `Object`.
5+
//!
6+
//! If you are looking for how to manage user-defined types (native scripts),
7+
//! check out the [`nativescript`][crate::nativescript] module.
28
39
use std::borrow::Borrow;
410
use std::ffi::CString;

0 commit comments

Comments
 (0)