Skip to content

Commit e78ac6f

Browse files
committed
Improve SCPreferences documentation
1 parent 6ca7124 commit e78ac6f

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

system-configuration/src/preferences.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
//!
1111
//! See the examples directory for examples how to use this module.
1212
//!
13-
//! [`SCPreferences`]: https://developer.apple.com/documentation/systemconfiguration/scpreferences
13+
//! [`SCPreferences`]: https://developer.apple.com/documentation/systemconfiguration/scpreferences-ft8
1414
1515

1616
use core_foundation::base::{CFAllocatorRef, TCFType};
@@ -45,7 +45,10 @@ impl SCPreferences {
4545
}
4646

4747
/// Initiates access to the per-system set of configuration preferences with a given
48-
/// allocator and preference group to access.
48+
/// allocator and preference group to access. See the underlying [SCPreferencesCreate] function
49+
/// documentation for details.
50+
///
51+
/// [SCPreferencesCreate]: https://developer.apple.com/documentation/systemconfiguration/1516807-scpreferencescreate?language=objc
4952
pub fn with_allocator(
5053
allocator: CFAllocatorRef,
5154
calling_process_name: &CFString,

0 commit comments

Comments
 (0)