Skip to content

Commit 3a1aeed

Browse files
elmarcoCBenoit
authored andcommitted
docs(rdpdr): fix rustdoc warnings
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
1 parent a096b14 commit 3a1aeed

File tree

3 files changed

+9
-11
lines changed

3 files changed

+9
-11
lines changed

crates/ironrdp-rdpdr/src/lib.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ pub struct Rdpdr {
4444
/// The name of the computer that is running the client.
4545
///
4646
/// Any directories shared will be displayed by File Explorer
47-
/// as "<directory> on <computer_name>".
47+
/// as "`<directory>` on `<computer_name>`".
4848
computer_name: String,
4949
capabilities: Capabilities,
5050
/// Pre-configured list of devices to announce to the server.
@@ -60,8 +60,6 @@ impl Rdpdr {
6060
pub const NAME: ChannelName = ChannelName::from_static(b"rdpdr\0\0\0");
6161

6262
/// Creates a new [`Rdpdr`].
63-
///
64-
/// See [`Rdpdr::computer_name`].
6563
pub fn new(backend: Box<dyn RdpdrBackend>, computer_name: String) -> Self {
6664
Self {
6765
computer_name,

crates/ironrdp-rdpdr/src/pdu/efs.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -734,8 +734,8 @@ bitflags! {
734734
///
735735
/// [Server Client ID Confirm (section 2.2.2.6)]: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpefs/bbbb9666-6994-4cf6-8e65-0d46eb319c6e
736736
/// [2.2.2.3]: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpefs/d6fe6d1b-c145-4a6f-99aa-4fe3cdcea398
737-
const VERSION_MINOR_12: u16 = 0x000C;
738-
const VERSION_MAJOR: u16 = 0x0001;
737+
pub const VERSION_MINOR_12: u16 = 0x000C;
738+
pub const VERSION_MAJOR: u16 = 0x0001;
739739

740740
/// [2.2.2.9] Client Device List Announce Request (DR_CORE_DEVICELIST_ANNOUNCE_REQ)
741741
/// and [2.2.3.1] Client Device List Announce (DR_DEVICELIST_ANNOUNCE)
@@ -2707,7 +2707,7 @@ impl ClientDriveQueryDirectoryResponse {
27072707
///
27082708
/// We only need to read the buffer up to the FileInformationClass to get the job done, so the rest of the fields in
27092709
/// this structure are discarded. See FreeRDP:
2710-
/// https://github.com/FreeRDP/FreeRDP/blob/511444a65e7aa2f537c5e531fa68157a50c1bd4d/channels/drive/client/drive_main.c#L464
2710+
/// <https://github.com/FreeRDP/FreeRDP/blob/511444a65e7aa2f537c5e531fa68157a50c1bd4d/channels/drive/client/drive_main.c#L464>
27112711
///
27122712
/// [2.2.3.3.6]: https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-rdpefs/484e622d-0e2b-423c-8461-7de38878effb
27132713
#[derive(Debug, PartialEq, Clone)]
@@ -2756,7 +2756,7 @@ impl ServerDriveQueryVolumeInformationRequest {
27562756

27572757
/// [2.5] File System Information Classes [MS-FSCC]
27582758
///
2759-
/// [2.5] https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-fscc/ee12042a-9352-46e3-9f67-c094b75fe6c3
2759+
/// [2.5] <https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-fscc/ee12042a-9352-46e3-9f67-c094b75fe6c3>
27602760
#[derive(Debug, PartialEq, Eq, Clone)]
27612761
pub struct FileSystemInformationClassLevel(u32);
27622762

crates/ironrdp-rdpdr/src/pdu/esc/rpce.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ impl<T> Pdu<T> {
9494
}
9595

9696
impl<T: HeaderlessDecode> Pdu<T> {
97-
/// Decodes the instance from a buffer stripping it of its [`StreamHeader`] and [`TypeHeader`].
97+
/// Decodes the instance from a buffer stripping it of its headers.
9898
pub fn decode(src: &mut ReadCursor<'_>, charset: Option<CharacterSet>) -> DecodeResult<Pdu<T>> {
9999
// We expect `StreamHeader::decode`, `TypeHeader::decode`, and `T::decode` to each
100100
// call `ensure_size!` to ensure that the buffer is large enough, so we can safely
@@ -146,11 +146,11 @@ pub trait Encode: ironrdp_core::Encode + Send + std::fmt::Debug {}
146146
///
147147
/// Implementers should typically implement this trait instead of [`Encode`].
148148
pub trait HeaderlessEncode: Send + std::fmt::Debug {
149-
/// Encodes the instance into a buffer sans its [`StreamHeader`] and [`TypeHeader`].
149+
/// Encodes the instance into a buffer sans its headers.
150150
fn encode(&self, dst: &mut WriteCursor<'_>) -> EncodeResult<()>;
151151
/// Returns the name associated with this RPCE PDU.
152152
fn name(&self) -> &'static str;
153-
/// Returns the size of the instance sans its [`StreamHeader`] and [`TypeHeader`].
153+
/// Returns the size of the instance sans its headers.
154154
fn size(&self) -> usize;
155155
}
156156

@@ -160,7 +160,7 @@ pub trait HeaderlessEncode: Send + std::fmt::Debug {
160160
/// and then call [`Pdu::decode`] to decode the instance. See [`Pdu`] for more
161161
/// details and an example.
162162
pub trait HeaderlessDecode: Sized {
163-
/// Decodes the instance from a buffer sans its [`StreamHeader`] and [`TypeHeader`].
163+
/// Decodes the instance from a buffer sans its headers.
164164
///
165165
/// `charset` is an optional parameter that can be used to specify the character set
166166
/// when relevant. This is useful for accounting for the "A" vs "W" variants of certain

0 commit comments

Comments
 (0)