add docs for `emulate_foreign_item_by_bame

diff --git a/src/shims/foreign_items.rs b/src/shims/foreign_items.rs
index 14e08f5181f527e151d3c1294a4320dfc29a819f..3df653d1741ab1856260cf56d2405c38c1d91ea6 100644 (file)
--- a/src/shims/foreign_items.rs
+++ b/src/shims/foreign_items.rs
@@ -178,6 +178,9 @@ fn emulate_foreign_item(
         Ok(None)
     }
 
+    /// Emulates calling a foreign item using its name, failing if the item is not supported.
+    /// Returns Ok(false) if after calling this function, the call should return earlier instead of
+    /// going to the next block.
     fn emulate_foreign_item_by_name(
         &mut self,
         link_name: &str,