22use std:: ffi:: CStr ;
33use std:: fmt:: { self , Display } ;
44
5+ // Collection of macros accessing the Godot engine log/print functionality
6+ pub use crate :: { godot_dbg, godot_error, godot_print, godot_site, godot_warn} ;
7+
58use crate :: core_types:: GodotString ;
69use crate :: private;
710
811/// Value representing a call site for errors and warnings. Can be constructed
9- /// using the `godot_site!` macro, or manually.
12+ /// using the [ `godot_site`] macro, or manually.
1013#[ derive( Copy , Clone , Debug ) ]
1114pub struct Site < ' a > {
1215 file : & ' a CStr ,
@@ -45,6 +48,8 @@ impl<'a> Display for Site<'a> {
4548
4649/// Print a message to the Godot console.
4750///
51+ /// Typically, you would use this through the [`godot_print`] macro.
52+ ///
4853/// # Panics
4954///
5055/// If the API isn't initialized.
@@ -58,6 +63,8 @@ pub fn print<S: Display>(msg: S) {
5863
5964/// Print a warning to the Godot console.
6065///
66+ /// Typically, you would use this through the [`godot_warn`] macro.
67+ ///
6168/// # Panics
6269///
6370/// If the API isn't initialized, or if the message contains any NUL-bytes.
@@ -78,6 +85,8 @@ pub fn warn<S: Display>(site: Site<'_>, msg: S) {
7885
7986/// Print an error to the Godot console.
8087///
88+ /// Typically, you would use this through the [`godot_error`] macro.
89+ ///
8190/// # Panics
8291///
8392/// If the API isn't initialized, or if the message contains any NUL-bytes.
0 commit comments