Skip to content

Commit 109ff27

Browse files
authored
Merge pull request rust-lang#210 from AndyGauge/doc_hyperlinks
Added hyperlinks to internal methods/structs/functions within docs.
2 parents 2b0d2be + c0481c9 commit 109ff27

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

src/lib.rs

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,15 @@
1010
//!
1111
//! The purpose of this crate is to provide the utility functions necessary to
1212
//! compile C code into a static archive which is then linked into a Rust crate.
13-
//! The top-level `compile_library` function serves as a convenience and more
14-
//! advanced configuration is available through the `Config` builder.
13+
//! The top-level [`compile_library`] function serves as a convenience. More
14+
//! advanced configuration is available through the [`Config`] builder.
1515
//!
1616
//! This crate will automatically detect situations such as cross compilation or
1717
//! other environment variables set by Cargo and will build code appropriately.
1818
//!
19+
//! [`compile_library`]: fn.compile_library.html
20+
//! [`Config`]: struct.Config.html
21+
//!
1922
//! # Examples
2023
//!
2124
//! Use the default configuration:
@@ -181,7 +184,9 @@ pub fn compile_library(output: &str, files: &[&str]) {
181184
impl Config {
182185
/// Construct a new instance of a blank set of configuration.
183186
///
184-
/// This builder is finished with the `compile` function.
187+
/// This builder is finished with the [`compile`] function.
188+
///
189+
/// [`compile`]: struct.Config.html#method.compile
185190
pub fn new() -> Config {
186191
Config {
187192
include_directories: Vec::new(),
@@ -392,7 +397,7 @@ impl Config {
392397
///
393398
/// This option is automatically scraped from the `HOST` environment
394399
/// variable by build scripts, so it's not required to call this function.
395-
///
400+
///
396401
/// # Example
397402
///
398403
/// ```no_run

0 commit comments

Comments
 (0)