Skip to content
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

More docs improvements #1576

Merged
merged 2 commits into from
Jun 3, 2024
Merged

More docs improvements #1576

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ff1555c
docs: Don't generate property docs for functions that have a getter/s…
bilelmoussaoui Jun 3, 2024
84db896
docs: Don't generate docs for Builder properties are not writable
bilelmoussaoui Jun 3, 2024
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
48 changes: 23 additions & 25 deletions src/codegen/doc/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,9 @@ fn create_object_doc(w: &mut dyn Write, env: &Env, info: &analysis::object::Info
}
}
for property in &builder_properties {
if !property.writable {
continue;
}
let ty = TypeStruct {
ty: SType::Fn,
name: nameutil::signal_to_snake(&property.name),
Expand Down Expand Up @@ -608,19 +611,25 @@ fn create_object_doc(w: &mut dyn Write, env: &Env, info: &analysis::object::Info
}

for property in properties {
let getter_name = info
.properties
.iter()
.filter(|p| p.is_get)
.find(|p| p.name == property.name)
.map(|p| p.func_name.clone());
let getter_name = if property.getter.is_some() {
None // Don't generate a getter for the property, there is a getter
} else {
info.properties
.iter()
.filter(|p| p.is_get)
.find(|p| p.name == property.name)
.map(|p| p.func_name.clone())
};
let setter_name = if property.setter.is_some() {
None // don't generate a setter for the property, there is a setter
} else {
info.properties
.iter()
.filter(|p| !p.is_get)
.find(|p| p.name == property.name)
.map(|p| p.func_name.clone())
};

let setter_name = info
.properties
.iter()
.filter(|p| !p.is_get)
.find(|p| p.name == property.name)
.map(|p| p.func_name.clone());
let (ty, object_location) = if has_trait {
let configured_properties = obj.properties.matched(&property.name);
if let Some(trait_name) = configured_properties
Expand Down Expand Up @@ -1009,26 +1018,15 @@ fn create_property_doc(
{
return Ok(());
}
let name_for_func = nameutil::signal_to_snake(&property.name);
let getter_name = getter_name.unwrap_or_else(|| name_for_func.clone());
let has_getter_method = obj_info.functions.iter().any(|f| {
f.func_name == getter_name || f.new_name.as_ref().map_or(false, |n| n == &getter_name)
});

let setter_name = setter_name.unwrap_or_else(|| format!("set_{}", &name_for_func));
let has_setter_method = obj_info.functions.iter().any(|f| {
f.func_name == setter_name || f.new_name.as_ref().map_or(false, |n| n == &setter_name)
});

let mut v = Vec::with_capacity(2);

if property.readable && !has_getter_method {
if let Some(getter_name) = getter_name {
v.push(TypeStruct {
parent: parent.clone(),
..TypeStruct::new(SType::Fn, &getter_name)
});
}
if property.writable && !property.construct_only && !has_setter_method {
if let Some(setter_name) = setter_name {
v.push(TypeStruct {
parent,
..TypeStruct::new(SType::Fn, &setter_name)
Expand Down
Loading