Add some intra-doc links to compiler docs

This commit is contained in:
Joshua Nelson 2020-12-22 09:54:23 -05:00
parent 50a90975c0
commit 9cd992f394
5 changed files with 13 additions and 5 deletions

View File

@ -257,7 +257,10 @@ pub struct Substructure<'a> {
pub type_ident: Ident, pub type_ident: Ident,
/// ident of the method /// ident of the method
pub method_ident: Ident, pub method_ident: Ident,
/// dereferenced access to any `Self_` or `Ptr(Self_, _)` arguments /// dereferenced access to any [`Self_`] or [`Ptr(Self_, _)][ptr]` arguments
///
/// [`Self_`]: ty::Ty::Self_
/// [ptr]: ty::Ty::Ptr
pub self_args: &'a [P<Expr>], pub self_args: &'a [P<Expr>],
/// verbatim access to any other arguments /// verbatim access to any other arguments
pub nonself_args: &'a [P<Expr>], pub nonself_args: &'a [P<Expr>],

View File

@ -25,8 +25,9 @@ use std::sync::{Arc, Mutex};
pub type Result<T> = result::Result<T, ErrorReported>; pub type Result<T> = result::Result<T, ErrorReported>;
/// Represents a compiler session. /// Represents a compiler session.
///
/// Can be used to run `rustc_interface` queries. /// Can be used to run `rustc_interface` queries.
/// Created by passing `Config` to `run_compiler`. /// Created by passing [`Config`] to [`run_compiler`].
pub struct Compiler { pub struct Compiler {
pub(crate) sess: Lrc<Session>, pub(crate) sess: Lrc<Session>,
codegen_backend: Lrc<Box<dyn CodegenBackend>>, codegen_backend: Lrc<Box<dyn CodegenBackend>>,

View File

@ -95,7 +95,7 @@ declare_box_region_type!(
/// harness if one is to be provided, injection of a dependency on the /// harness if one is to be provided, injection of a dependency on the
/// standard library and prelude, and name resolution. /// standard library and prelude, and name resolution.
/// ///
/// Returns `None` if we're aborting after handling -W help. /// Returns [`None`] if we're aborting after handling -W help.
pub fn configure_and_expand( pub fn configure_and_expand(
sess: Lrc<Session>, sess: Lrc<Session>,
lint_store: Lrc<LintStore>, lint_store: Lrc<LintStore>,

View File

@ -23,7 +23,11 @@ use std::cell::{Ref, RefCell, RefMut};
use std::rc::Rc; use std::rc::Rc;
/// Represent the result of a query. /// Represent the result of a query.
/// This result can be stolen with the `take` method and generated with the `compute` method. ///
/// This result can be stolen with the [`take`] method and generated with the [`compute`] method.
///
/// [`take`]: Self::take
/// [`compute`]: Self::compute
pub struct Query<T> { pub struct Query<T> {
result: RefCell<Option<Result<T>>>, result: RefCell<Option<Result<T>>>,
} }

View File

@ -1681,7 +1681,7 @@ fn with_interner<T, F: FnOnce(&mut Interner) -> T>(f: F) -> T {
SESSION_GLOBALS.with(|session_globals| f(&mut *session_globals.symbol_interner.lock())) SESSION_GLOBALS.with(|session_globals| f(&mut *session_globals.symbol_interner.lock()))
} }
/// An alternative to `Symbol`, useful when the chars within the symbol need to /// An alternative to [`Symbol`], useful when the chars within the symbol need to
/// be accessed. It deliberately has limited functionality and should only be /// be accessed. It deliberately has limited functionality and should only be
/// used for temporary values. /// used for temporary values.
/// ///