Update HandlerFuncType documentation

josephlr · josephlr · commit faea2730fec1 · 2023-09-23T18:47:52.000-07:00
Signed-off-by: Joe Richey &lt;joerichey@google.com&gt;
diff --git a/src/structures/idt.rs b/src/structures/idt.rs
@@ -797,9 +797,9 @@ impl<F: HandlerFuncType> Entry<F> {
     }
 }
 
-/// The trait for all function types that can be used as a handler function in `Entry`.
+/// A common trait for all handler functions usable in [`Entry`].
 pub trait HandlerFuncType {
-    /// Get the virtual memory address of the function
+    /// Get the virtual address of the handler function.
     fn to_virt_addr(self) -> VirtAddr;
 }
 

Original file line number	Diff line number	Diff line change
`@@ -797,9 +797,9 @@ impl<F: HandlerFuncType> Entry<F> {`
`797`	`797`	`}`
`798`	`798`	`}`
`799`	`799`
`800`		-/// The trait for all function types that can be used as a handler function in `Entry`.
	`800`	+/// A common trait for all handler functions usable in [`Entry`].
`801`	`801`	`pub trait HandlerFuncType {`
`802`		`- /// Get the virtual memory address of the function`
	`802`	`+ /// Get the virtual address of the handler function.`
`803`	`803`	`fn to_virt_addr(self) -> VirtAddr;`
`804`	`804`	`}`
`805`	`805`