commit fb204270957140b92a7fd05ee71a39ffd33951ad
author Googler <no-reply@google.com> Fri Dec 02 00:52:05 2022 -0800
committer Copybara-Service <copybara-worker@google.com> Fri Dec 02 00:52:48 2022 -0800
tree 76d80256324c3fe78bef18c3719ab2be843a28ee
parent b4beb39c75a3efb909d2e7c54d7a8751ffe5af88

Move logic for formatting doc comments into its own function

To be used for formatting doc comments for ADTs.

Also update doc comment for `format_fn` to reflect the renaming of the LocalDefId parameter.

PiperOrigin-RevId: 492403059

cc_bindings_from_rs/bindings.rs

diff --git a/cc_bindings_from_rs/bindings.rs b/cc_bindings_from_rs/bindings.rs
index 492c7c1..f8f276a 100644
--- a/cc_bindings_from_rs/bindings.rs
+++ b/cc_bindings_from_rs/bindings.rs
@@ -434,9 +434,9 @@
     }
 }
 
-/// Formats a function with the given `def_id`.
+/// Formats a function with the given `local_def_id`.
 ///
-/// Will panic if `def_id`
+/// Will panic if `local_def_id`
 /// - is invalid
 /// - doesn't identify a function,
 /// - has generic parameters of any kind - lifetime parameters (see also
@@ -501,21 +501,11 @@
     };
 
     let doc_comment = {
-        let hir_id = tcx.local_def_id_to_hir_id(local_def_id);
-        let doc_comment: String = tcx
-            .hir()
-            .attrs(hir_id)
-            .iter()
-            .filter_map(|attr| match &attr.doc_str() {
-                None => None,
-                Some(symbol) => Some(symbol.as_str().to_owned()),
-            })
-            .collect_vec()
-            .join("\n");
+        let doc_comment = format_doc_comment(tcx, local_def_id);
         if doc_comment.is_empty() {
-            quote! {}
+            quote!{}
         } else {
-            quote! { __NEWLINE__ __COMMENT__ #doc_comment }
+            quote! { __NEWLINE__ #doc_comment }
         }
     };
 
@@ -833,6 +823,28 @@
     Ok(MixedSnippet { cc: CcSnippet { includes, snippet: cc_snippet }, rs: rs_assertions })
 }
 
+/// Formats the doc comment associated with the item identified by
+/// `local_def_id`.
+/// If there is no associated doc comment, an empty `TokenStream` is returned.
+fn format_doc_comment(tcx: TyCtxt, local_def_id: LocalDefId) -> TokenStream {
+    let hir_id = tcx.local_def_id_to_hir_id(local_def_id);
+    let doc_comment: String = tcx
+        .hir()
+        .attrs(hir_id)
+        .iter()
+        .filter_map(|attr| match &attr.doc_str() {
+            None => None,
+            Some(symbol) => Some(symbol.as_str().to_owned()),
+        })
+        .collect_vec()
+        .join("\n");
+    if doc_comment.is_empty() {
+        quote! {}
+    } else {
+        quote! { __COMMENT__ #doc_comment}
+    }
+}
+
 /// Formats a Rust item idenfied by `def_id`.
 ///
 /// Will panic if `def_id` is invalid (i.e. doesn't identify a Rust node or