uucore: mark comment as rustdoc

BenWiederhake · BenWiederhake · commit 66112fb00a09 · 2024-07-19T20:39:43.000+02:00
diff --git a/src/uucore/src/lib/lib.rs b/src/uucore/src/lib/lib.rs
@@ -222,9 +222,9 @@ pub fn read_yes() -> bool {
     }
 }
 
-// Helper function for processing delimiter values (which could be non UTF-8)
-// It converts OsString to &[u8] for unix targets only
-// On non-unix (i.e. Windows) it will just return an error if delimiter value is not UTF-8
+/// Helper function for processing delimiter values (which could be non UTF-8)
+/// It converts OsString to &[u8] for unix targets only
+/// On non-unix (i.e. Windows) it will just return an error if delimiter value is not UTF-8
 pub fn os_str_as_bytes(os_string: &OsStr) -> mods::error::UResult<&[u8]> {
     #[cfg(unix)]
     let bytes = os_string.as_bytes();

Original file line number	Diff line number	Diff line change
`@@ -222,9 +222,9 @@ pub fn read_yes() -> bool {`
`222`	`222`	`}`
`223`	`223`	`}`
`224`	`224`
`225`		`-// Helper function for processing delimiter values (which could be non UTF-8)`
`226`		`-// It converts OsString to &[u8] for unix targets only`
`227`		`-// On non-unix (i.e. Windows) it will just return an error if delimiter value is not UTF-8`
	`225`	`+/// Helper function for processing delimiter values (which could be non UTF-8)`
	`226`	`+/// It converts OsString to &[u8] for unix targets only`
	`227`	`+/// On non-unix (i.e. Windows) it will just return an error if delimiter value is not UTF-8`
`228`	`228`	`pub fn os_str_as_bytes(os_string: &OsStr) -> mods::error::UResult<&[u8]> {`
`229`	`229`	`#[cfg(unix)]`
`230`	`230`	`let bytes = os_string.as_bytes();`