Fix rustdoc warnings by escaping [pid] in documentation comments
This commit is contained in:
@@ -837,7 +837,7 @@ mod platform {
|
|||||||
/// # Platform Support
|
/// # Platform Support
|
||||||
///
|
///
|
||||||
/// - **Windows**: Uses VirtualQueryEx to enumerate regions.
|
/// - **Windows**: Uses VirtualQueryEx to enumerate regions.
|
||||||
/// - **Linux**: Parses /proc/[pid]/maps.
|
/// - **Linux**: Parses /proc/\[pid\]/maps.
|
||||||
/// - **macOS**: Not yet implemented.
|
/// - **macOS**: Not yet implemented.
|
||||||
pub fn enumerate_memory_regions(pid: u32) -> anyhow::Result<Vec<MemoryRegion>> {
|
pub fn enumerate_memory_regions(pid: u32) -> anyhow::Result<Vec<MemoryRegion>> {
|
||||||
platform::enumerate_memory_regions(pid)
|
platform::enumerate_memory_regions(pid)
|
||||||
@@ -851,7 +851,7 @@ pub fn enumerate_memory_regions(pid: u32) -> anyhow::Result<Vec<MemoryRegion>> {
|
|||||||
/// # Platform Support
|
/// # Platform Support
|
||||||
///
|
///
|
||||||
/// - **Windows**: Uses ReadProcessMemory API.
|
/// - **Windows**: Uses ReadProcessMemory API.
|
||||||
/// - **Linux**: Reads from /proc/[pid]/mem.
|
/// - **Linux**: Reads from /proc/\[pid\]/mem.
|
||||||
/// - **macOS**: Not yet implemented.
|
/// - **macOS**: Not yet implemented.
|
||||||
pub fn read_process_memory(pid: u32, address: usize, size: usize) -> anyhow::Result<Vec<u8>> {
|
pub fn read_process_memory(pid: u32, address: usize, size: usize) -> anyhow::Result<Vec<u8>> {
|
||||||
platform::read_process_memory(pid, address, size)
|
platform::read_process_memory(pid, address, size)
|
||||||
|
|||||||
@@ -970,7 +970,7 @@ mod platform {
|
|||||||
/// # Platform Support
|
/// # Platform Support
|
||||||
///
|
///
|
||||||
/// - **Windows**: Uses CreateToolhelp32Snapshot with NtQueryInformationThread for start addresses.
|
/// - **Windows**: Uses CreateToolhelp32Snapshot with NtQueryInformationThread for start addresses.
|
||||||
/// - **Linux**: Parses /proc/[pid]/task/ directory.
|
/// - **Linux**: Parses /proc/\[pid\]/task/ directory.
|
||||||
/// - **macOS**: Not yet implemented.
|
/// - **macOS**: Not yet implemented.
|
||||||
///
|
///
|
||||||
/// # Returns
|
/// # Returns
|
||||||
|
|||||||
Reference in New Issue
Block a user