Browse Source

Merge pull request #210 from AndyGauge/doc_hyperlinks

Added hyperlinks to internal methods/structs/functions within docs.
cmd
Alex Crichton 8 years ago
committed by GitHub
parent
commit
109ff274a7
  1. 11
      src/lib.rs

11
src/lib.rs

@ -10,12 +10,15 @@
//! //!
//! The purpose of this crate is to provide the utility functions necessary to //! 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. //! 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 //! The top-level [`compile_library`] function serves as a convenience. More
//! advanced configuration is available through the `Config` builder. //! advanced configuration is available through the [`Config`] builder.
//! //!
//! This crate will automatically detect situations such as cross compilation or //! This crate will automatically detect situations such as cross compilation or
//! other environment variables set by Cargo and will build code appropriately. //! other environment variables set by Cargo and will build code appropriately.
//! //!
//! [`compile_library`]: fn.compile_library.html
//! [`Config`]: struct.Config.html
//!
//! # Examples //! # Examples
//! //!
//! Use the default configuration: //! Use the default configuration:
@ -181,7 +184,9 @@ pub fn compile_library(output: &str, files: &[&str]) {
impl Config { impl Config {
/// Construct a new instance of a blank set of configuration. /// 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 { pub fn new() -> Config {
Config { Config {
include_directories: Vec::new(), include_directories: Vec::new(),

Loading…
Cancel
Save