aboutsummaryrefslogtreecommitdiff
path: root/src/searchresult.rs
diff options
context:
space:
mode:
authorNathan Reiner <nathan@nathanreiner.xyz>2023-07-06 14:20:14 +0200
committerNathan Reiner <nathan@nathanreiner.xyz>2023-07-06 14:20:14 +0200
commit9b4aa4e9643b0a5b4a554e455eac269a2472b590 (patch)
treecdab839b50a137db2a6df480a0f75f1f1385cb41 /src/searchresult.rs
parent8c3c8efa428200c67c1a6fa731faee55adf19678 (diff)
add some documentation to structs
Diffstat (limited to 'src/searchresult.rs')
-rw-r--r--src/searchresult.rs3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/searchresult.rs b/src/searchresult.rs
index 6a0dd30..cc882ff 100644
--- a/src/searchresult.rs
+++ b/src/searchresult.rs
@@ -1,4 +1,5 @@
-
+/// This struct is returned by the index::Index::search
+/// function.
pub struct SearchResult {
pub priority : u64,
pub path : String