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

Remove doc comments #2830

Merged
merged 4 commits into from
Feb 1, 2024
Merged

Remove doc comments #2830

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8a1fb2a
bindgen
kennykerr Feb 1, 2024
2930a76
windows-sys code gen
kennykerr Feb 1, 2024
095e648
windows code gen
kennykerr Feb 1, 2024
5a4a65d
targets
kennykerr Feb 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 0 additions & 3 deletions crates/libs/bindgen/src/rust/classes.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ fn gen_class(writer: &Writer, def: metadata::TypeDef) -> TokenStream {
let mut method_names = MethodNames::new();

let cfg = cfg::type_def_cfg(writer, def, &[]);
let doc = writer.cfg_doc(&cfg);
let features = writer.cfg_features(&cfg);

for interface in &interfaces {
Expand Down Expand Up @@ -84,7 +83,6 @@ fn gen_class(writer: &Writer, def: metadata::TypeDef) -> TokenStream {
};

let mut tokens = quote! {
#doc
#features
#[repr(transparent)]
#[derive(::core::cmp::PartialEq, ::core::cmp::Eq, ::core::fmt::Debug, ::core::clone::Clone)]
Expand All @@ -111,7 +109,6 @@ fn gen_class(writer: &Writer, def: metadata::TypeDef) -> TokenStream {
tokens
} else {
let mut tokens = quote! {
#doc
#features
pub struct #name;
#features
Expand Down
10 changes: 0 additions & 10 deletions crates/libs/bindgen/src/rust/com_methods.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef, kind: metadata::Interface
let where_clause = writer.where_clause(&signature.params);
let mut cfg = cfg::signature_cfg(writer, method);
cfg.add_feature(def.namespace());
let doc = writer.cfg_method_doc(&cfg);
let features = writer.cfg_features(&cfg);

if kind == metadata::InterfaceKind::None {
Expand All @@ -31,7 +30,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef, kind: metadata::Interface
let where_clause = expand_where_clause(where_clause, quote!(T: ::windows_core::Interface));

quote! {
#doc
#features
pub unsafe fn #name<#generics>(&self, #params) -> ::windows_core::Result<T> #where_clause {
let mut result__ = ::std::ptr::null_mut();
Expand All @@ -46,7 +44,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef, kind: metadata::Interface
let where_clause = expand_where_clause(where_clause, quote!(T: ::windows_core::Interface));

quote! {
#doc
#features
pub unsafe fn #name<#generics>(&self, #params result__: *mut ::core::option::Option<T>) -> ::windows_core::Result<()> #where_clause {
(::windows_core::Interface::vtable(self)#bases.#vname)(::windows_core::Interface::as_raw(self), #args).ok()
Expand All @@ -60,7 +57,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef, kind: metadata::Interface
let return_type = writer.type_name(&return_type);

quote! {
#doc
#features
pub unsafe fn #name<#generics>(&self, #params) -> ::windows_core::Result<#return_type> #where_clause {
let mut result__ = ::std::mem::zeroed();
Expand All @@ -73,7 +69,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef, kind: metadata::Interface
let params = writer.win32_params(&signature.params, kind);

quote! {
#doc
#features
pub unsafe fn #name<#generics>(&self, #params) -> ::windows_core::Result<()> #where_clause {
(::windows_core::Interface::vtable(self)#bases.#vname)(::windows_core::Interface::as_raw(self), #args).ok()
Expand All @@ -89,7 +84,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef, kind: metadata::Interface

if is_nullable {
quote! {
#doc
#features
pub unsafe fn #name<#generics>(&self, #params) -> ::windows_core::Result<#return_type> #where_clause {
let mut result__ = ::std::mem::zeroed();
Expand All @@ -99,7 +93,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef, kind: metadata::Interface
}
} else {
quote! {
#doc
#features
pub unsafe fn #name<#generics>(&self, #params) -> #return_type #where_clause {
let mut result__ = ::std::mem::zeroed();
Expand All @@ -115,7 +108,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef, kind: metadata::Interface
let return_type = writer.type_name(&signature.return_type);

quote! {
#doc
#features
pub unsafe fn #name<#generics>(&self, #params) -> #return_type #where_clause {
let mut result__: #return_type = ::core::mem::zeroed();
Expand All @@ -130,7 +122,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef, kind: metadata::Interface
let return_type = writer.return_sig(&signature);

quote! {
#doc
#features
pub unsafe fn #name<#generics>(&self, #params) #return_type #where_clause {
(::windows_core::Interface::vtable(self)#bases.#vname)(::windows_core::Interface::as_raw(self), #args)
Expand All @@ -142,7 +133,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef, kind: metadata::Interface
let params = writer.win32_params(&signature.params, kind);

quote! {
#doc
#features
pub unsafe fn #name<#generics>(&self, #params) #where_clause {
(::windows_core::Interface::vtable(self)#bases.#vname)(::windows_core::Interface::as_raw(self), #args)
Expand Down
8 changes: 0 additions & 8 deletions crates/libs/bindgen/src/rust/constants.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ pub fn writer(writer: &Writer, def: metadata::Field) -> TokenStream {
let name = to_ident(def.name());
let ty = def.ty(None).to_const_type();
let cfg = cfg::field_cfg(writer, def);
let doc = writer.cfg_doc(&cfg);
let features = writer.cfg_features(&cfg);

if let Some(constant) = def.constant() {
Expand All @@ -17,22 +16,19 @@ pub fn writer(writer: &Writer, def: metadata::Field) -> TokenStream {
if field_is_ansi(def) {
let value = writer.value(&constant.value());
quote! {
#doc
#features
pub const #name: #crate_name PCSTR = #crate_name s!(#value);
}
} else {
let value = writer.value(&constant.value());
quote! {
#doc
#features
pub const #name: #crate_name PCWSTR = #crate_name w!(#value);
}
}
} else {
let value = writer.typed_value(&constant.value());
quote! {
#doc
#features
pub const #name: #value;
}
Expand All @@ -50,13 +46,11 @@ pub fn writer(writer: &Writer, def: metadata::Field) -> TokenStream {

if !writer.sys && type_has_replacement(&ty) {
quote! {
#doc
#features
pub const #name: #kind = #kind(#value);
}
} else {
quote! {
#doc
#features
pub const #name: #kind = #value;
}
Expand All @@ -66,14 +60,12 @@ pub fn writer(writer: &Writer, def: metadata::Field) -> TokenStream {
let value = writer.guid(&guid);
let guid = writer.type_name(&metadata::Type::GUID);
quote! {
#doc
pub const #name: #guid = #value;
}
} else if let Some(value) = initializer(writer, def) {
let kind = writer.type_default_name(&ty);

quote! {
#doc
#features
pub const #name: #kind = #kind { #value };
}
Expand Down
6 changes: 1 addition & 5 deletions crates/libs/bindgen/src/rust/delegates.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ fn gen_callback(writer: &Writer, def: metadata::TypeDef) -> TokenStream {

let return_type = writer.return_sig(&signature);
let cfg = cfg::type_def_cfg(writer, def, &[]);
let doc = writer.cfg_doc(&cfg);
let features = writer.cfg_features(&cfg);

let params = signature.params.iter().map(|p| {
Expand All @@ -26,7 +25,6 @@ fn gen_callback(writer: &Writer, def: metadata::TypeDef) -> TokenStream {
});

quote! {
#doc
#features
pub type #name = ::core::option::Option<unsafe extern "system" fn(#(#params),*) #return_type>;
}
Expand Down Expand Up @@ -61,7 +59,6 @@ fn gen_win_delegate(writer: &Writer, def: metadata::TypeDef) -> TokenStream {

let fn_constraint = gen_fn_constraint(writer, def, &signature);
let cfg = cfg::type_def_cfg(writer, def, generics);
let doc = writer.cfg_doc(&cfg);
let features = writer.cfg_features(&cfg);

let vtbl_signature = writer.vtbl_signature(def, true, &signature);
Expand All @@ -72,11 +69,10 @@ fn gen_win_delegate(writer: &Writer, def: metadata::TypeDef) -> TokenStream {
let iid = writer.guid_literal(metadata::type_def_guid(def));
quote! {
#features
::windows_core::imp::com_interface!(#doc #ident, #vtbl, #iid);
::windows_core::imp::com_interface!(#ident, #vtbl, #iid);
}
} else {
quote! {
#doc
#features
#[repr(transparent)]
#[derive(::core::cmp::PartialEq, ::core::cmp::Eq, ::core::fmt::Debug, ::core::clone::Clone)]
Expand Down
3 changes: 0 additions & 3 deletions crates/libs/bindgen/src/rust/enums.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef) -> TokenStream {
let is_scoped = def.flags().contains(metadata::TypeAttributes::WindowsRuntime) || def.has_attribute("ScopedEnumAttribute");

let cfg = cfg::type_def_cfg(writer, def, &[]);
let doc = writer.cfg_doc(&cfg);
let features = writer.cfg_features(&cfg);

let fields: Vec<(TokenStream, TokenStream)> = def
Expand Down Expand Up @@ -45,15 +44,13 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef) -> TokenStream {

let mut tokens = if is_scoped || !writer.sys {
quote! {
#doc
#features
#[repr(transparent)]
#derive
pub struct #ident(pub #underlying_type);
}
} else {
quote! {
#doc
#features
pub type #ident = #underlying_type;
}
Expand Down
20 changes: 4 additions & 16 deletions crates/libs/bindgen/src/rust/functions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ fn gen_sys_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)
let signature = metadata::method_def_signature(namespace, def, &[]);
let cfg = cfg::signature_cfg(writer, def);
let mut tokens = writer.cfg_features(&cfg);
tokens.combine(&gen_link(writer, namespace, &signature, &cfg));
tokens.combine(&gen_link(writer, namespace, &signature));
tokens
}

Expand All @@ -36,9 +36,8 @@ fn gen_win_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)
let where_clause = writer.where_clause(&signature.params);
let abi_return_type = writer.return_sig(&signature);
let cfg = cfg::signature_cfg(writer, def);
let doc = writer.cfg_doc(&cfg);
let features = writer.cfg_features(&cfg);
let link = gen_link(writer, namespace, &signature, &cfg);
let link = gen_link(writer, namespace, &signature);

let kind = signature.kind();
match kind {
Expand All @@ -49,7 +48,6 @@ fn gen_win_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)
let where_clause = expand_where_clause(where_clause, quote!(T: ::windows_core::Interface));

quote! {
#doc
#features
#[inline]
pub unsafe fn #name<#generics>(#params) -> ::windows_core::Result<T> #where_clause {
Expand All @@ -66,7 +64,6 @@ fn gen_win_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)
let where_clause = expand_where_clause(where_clause, quote!(T: ::windows_core::Interface));

quote! {
#doc
#features
#[inline]
pub unsafe fn #name<#generics>(#params result__: *mut ::core::option::Option<T>) -> ::windows_core::Result<()> #where_clause {
Expand All @@ -82,7 +79,6 @@ fn gen_win_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)
let return_type = writer.type_name(&return_type);

quote! {
#doc
#features
#[inline]
pub unsafe fn #name<#generics>(#params) -> ::windows_core::Result<#return_type> #where_clause {
Expand All @@ -97,7 +93,6 @@ fn gen_win_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)
let params = writer.win32_params(&signature.params, kind);

quote! {
#doc
#features
#[inline]
pub unsafe fn #name<#generics>(#params) -> ::windows_core::Result<()> #where_clause {
Expand All @@ -115,7 +110,6 @@ fn gen_win_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)

if is_nullable {
quote! {
#doc
#features
#[inline]
pub unsafe fn #name<#generics>(#params) -> ::windows_core::Result<#return_type> #where_clause {
Expand All @@ -127,7 +121,6 @@ fn gen_win_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)
}
} else {
quote! {
#doc
#features
#[inline]
pub unsafe fn #name<#generics>(#params) -> #return_type #where_clause {
Expand All @@ -146,7 +139,6 @@ fn gen_win_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)
let return_type = writer.type_name(&signature.return_type);

quote! {
#doc
#features
#[inline]
pub unsafe fn #name<#generics>(#params) -> ::windows_core::Result<#return_type> #where_clause {
Expand All @@ -160,7 +152,6 @@ fn gen_win_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)
let params = writer.win32_params(&signature.params, kind);

quote! {
#doc
#features
#[inline]
pub unsafe fn #name<#generics>(#params) #abi_return_type #where_clause {
Expand All @@ -176,7 +167,6 @@ fn gen_win_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)
let does_not_return = does_not_return(def);

quote! {
#doc
#features
#[inline]
pub unsafe fn #name<#generics>(#params) #does_not_return #where_clause {
Expand All @@ -188,7 +178,7 @@ fn gen_win_function(writer: &Writer, namespace: &str, def: metadata::MethodDef)
}
}

fn gen_link(writer: &Writer, namespace: &str, signature: &metadata::Signature, cfg: &cfg::Cfg) -> TokenStream {
fn gen_link(writer: &Writer, namespace: &str, signature: &metadata::Signature) -> TokenStream {
let name = signature.def.name();
let ident = to_ident(name);
let library = signature.def.module_name();
Expand Down Expand Up @@ -229,15 +219,13 @@ fn gen_link(writer: &Writer, namespace: &str, signature: &metadata::Signature, c
} else {
let symbol = if symbol != name { format!(" \"{symbol}\"") } else { String::new() };

let doc = if writer.sys { writer.cfg_doc(cfg).0 } else { String::new() };

let mut tokens = String::new();
for param in params {
tokens.push_str(&format!("{}, ", param.as_str()));
}
tokens.push_str(&vararg.0);
let tokens = tokens.trim_end_matches(", ");
format!(r#"::windows_targets::link!("{library}" "{abi}"{symbol}{doc} fn {name}({tokens}){return_type});"#).into()
format!(r#"::windows_targets::link!("{library}" "{abi}"{symbol} fn {name}({tokens}){return_type});"#).into()
}
}

Expand Down
3 changes: 0 additions & 3 deletions crates/libs/bindgen/src/rust/implements.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef) -> TokenStream {
let generic_names = writer.generic_names(generics);
let named_phantoms = writer.generic_named_phantoms(generics);
let cfg = cfg::type_def_cfg_impl(writer, def, generics);
let doc = writer.cfg_doc(&cfg);
let features = writer.cfg_features(&cfg);
let mut requires = quote! {};
let type_ident = quote! { #type_ident<#generic_names> };
Expand Down Expand Up @@ -128,7 +127,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef) -> TokenStream {

if has_unknown_base {
quote! {
#doc
#features
pub trait #impl_ident<#generic_names> : Sized #requires where #constraints {
#(#method_traits)*
Expand All @@ -150,7 +148,6 @@ pub fn writer(writer: &Writer, def: metadata::TypeDef) -> TokenStream {
}
} else {
quote! {
#doc
#features
pub trait #impl_ident : Sized #requires {
#(#method_traits)*
Expand Down
5 changes: 1 addition & 4 deletions crates/libs/bindgen/src/rust/interfaces.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ fn gen_win_interface(writer: &Writer, def: metadata::TypeDef) -> TokenStream {
let phantoms = writer.generic_phantoms(generics);
let constraints = writer.generic_constraints(generics);
let cfg = cfg::type_def_cfg(writer, def, &[]);
let doc = writer.cfg_doc(&cfg);
let features = writer.cfg_features(&cfg);
let interfaces = metadata::type_interfaces(&metadata::Type::TypeDef(def, generics.to_vec()));
let vtables = metadata::type_def_vtables(def);
Expand All @@ -29,11 +28,10 @@ fn gen_win_interface(writer: &Writer, def: metadata::TypeDef) -> TokenStream {
let iid = writer.guid_literal(metadata::type_def_guid(def));
tokens.combine(&quote! {
#features
::windows_core::imp::com_interface!(#doc #ident, #vtbl_ident, #iid);
::windows_core::imp::com_interface!(#ident, #vtbl_ident, #iid);
});
} else {
tokens.combine(&quote! {
#doc
#features
#[repr(transparent)]
#[derive(::core::cmp::PartialEq, ::core::cmp::Eq, ::core::fmt::Debug, ::core::clone::Clone)]
Expand All @@ -42,7 +40,6 @@ fn gen_win_interface(writer: &Writer, def: metadata::TypeDef) -> TokenStream {
}
} else {
tokens.combine(&quote! {
#doc
#features
::windows_core::imp::interface!(#ident, #vtbl_ident);
});
Expand Down
Loading