Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added hyperlinks to internal methods/structs/functions within docs. #210

Merged
merged 1 commit into from Jul 18, 2017
Merged

Added hyperlinks to internal methods/structs/functions within docs. #210

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 9 additions & 4 deletions src/lib.rs
View file
Open in desktop
Expand Up @@ -10,12 +10,15 @@
//!
//! The purpose of this crate is to provide the utility functions necessary to
//! compile C code into a static archive which is then linked into a Rust crate.
//! The top-level `compile_library` function serves as a convenience and more
//! advanced configuration is available through the `Config` builder.
//! The top-level [`compile_library`] function serves as a convenience. More
//! advanced configuration is available through the [`Config`] builder.
//!
//! This crate will automatically detect situations such as cross compilation or
//! other environment variables set by Cargo and will build code appropriately.
//!
//! [`compile_library`]: fn.compile_library.html
//! [`Config`]: struct.Config.html
//!
//! # Examples
//!
//! Use the default configuration:
Expand Down Expand Up @@ -181,7 +184,9 @@ pub fn compile_library(output: &str, files: &[&str]) {
impl Config {
/// Construct a new instance of a blank set of configuration.
///
/// This builder is finished with the `compile` function.
/// This builder is finished with the [`compile`] function.
///
/// [`compile`]: struct.Config.html#method.compile
pub fn new() -> Config {
Config {
include_directories: Vec::new(),
Expand Down Expand Up @@ -392,7 +397,7 @@ impl Config {
///
/// This option is automatically scraped from the `HOST` environment
/// variable by build scripts, so it's not required to call this function.
///
///
/// # Example
///
/// ```no_run
Expand Down