Add doc on function and export module

Cargo.lock

@@ -711,17 +711,6 @@ version = "0.2.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d"
 
-[[package]]
-name = "orc-rs"
-version = "0.1.0"
-dependencies = [
- "anyhow",
- "cargo-scaffold",
- "clap",
- "elf",
- "thiserror",
-]
-
 [[package]]
 name = "percent-encoding"
 version = "2.3.1"
@@ -1113,6 +1102,17 @@ dependencies = [
  "winnow",
 ]
 
+[[package]]
+name = "troll-rs"
+version = "0.1.0"
+dependencies = [
+ "anyhow",
+ "cargo-scaffold",
+ "clap",
+ "elf",
+ "thiserror",
+]
+
 [[package]]
 name = "typenum"
 version = "1.17.0"

src/lib.rs

@@ -2,8 +2,8 @@
 
 mod link;
 mod new;
-mod rel_iter;
-mod symbols;
+pub mod rel_iter;
+pub mod symbols;
 
 use anyhow::Result;
 use clap::{Parser, Subcommand};

src/symbols.rs

@@ -47,6 +47,7 @@ impl<'data, E: EndianParse> SymbolsQuery<'data, E> {
         Self { symtab, strtab }
     }
 
+    /// Returns a new symbol table query object from an elf file
     pub fn from_elf(elf: &'data ElfBytes<'data, E>) -> Result<'_, Self> {
         let common_sections = elf.find_common_data()?;