Skip to content

docs: ClassBuilder::property(): remove outdated documentation #603

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Xenira merged 1 commit into from
Dec 15, 2025
+1 −9
Merged

docs: ClassBuilder::property(): remove outdated documentation #603

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 1 addition & 9 deletions src/builders/class.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,21 +99,13 @@ impl ClassBuilder {
self
}

/// Adds a property to the class. The initial type of the property is given
/// by the type of the given default. Note that the user can change the
/// type.
/// Adds a property to the class.
///
/// # Parameters
///
/// * `name` - The name of the property to add to the class.
/// * `default` - The default value of the property.
/// * `flags` - Flags relating to the property. See [`PropertyFlags`].
/// * `docs` - Documentation comments for the property.
///
/// # Panics
///
/// Function will panic if the given `default` cannot be converted into a
/// [`Zval`].
pub fn property<T: Into<String>>(
mut self,
name: T,
Expand Down