Skip to content

Commit b491557

Browse files
committed
document fields of Library struct
1 parent 317737b commit b491557

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/lib.rs

+11
Original file line numberDiff line numberDiff line change
@@ -93,15 +93,26 @@ pub struct Config {
9393

9494
#[derive(Clone, Debug)]
9595
pub struct Library {
96+
/// Libraries specified by -l
9697
pub libs: Vec<String>,
98+
/// Library search paths specified by -L
9799
pub link_paths: Vec<PathBuf>,
100+
/// Library file paths specified without -l
98101
pub link_files: Vec<PathBuf>,
102+
/// Darwin frameworks specified by -framework
99103
pub frameworks: Vec<String>,
104+
/// Darwin framework search paths specified by -F
100105
pub framework_paths: Vec<PathBuf>,
106+
/// C/C++ header include paths specified by -I
101107
pub include_paths: Vec<PathBuf>,
108+
/// Linker options specified by -Wl
102109
pub ld_args: Vec<Vec<String>>,
110+
/// C/C++ definitions specified by -D
103111
pub defines: HashMap<String, Option<String>>,
112+
/// Version specified by .pc file's Version field
104113
pub version: String,
114+
/// Ensure that this struct can only be created via its private `[Library::new]` constructor.
115+
/// Users of this crate can only access the struct via `[Config::probe]`.
105116
_priv: (),
106117
}
107118

0 commit comments

Comments
 (0)