From 4d58821eee014c231c7a8d4802c3f221bbe14890 Mon Sep 17 00:00:00 2001 From: Philipp Hansch Date: Wed, 3 Oct 2018 13:24:44 +0200 Subject: [PATCH] Add examples to `TyKind::FnDef` and `TyKind::FnPtr` docs --- src/librustc/ty/sty.rs | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/librustc/ty/sty.rs b/src/librustc/ty/sty.rs index 8e4819b68a95..4cf4668443fb 100644 --- a/src/librustc/ty/sty.rs +++ b/src/librustc/ty/sty.rs @@ -127,9 +127,26 @@ pub enum TyKind<'tcx> { /// The anonymous type of a function declaration/definition. Each /// function has a unique type. + /// + /// For example the type of `a` here: + /// + /// ```rust + /// fn foo() -> i32 { 1 } + /// + /// fn hello() { + /// let a = foo; + /// } + /// ``` FnDef(DefId, &'tcx Substs<'tcx>), /// A pointer to a function. Written as `fn() -> i32`. + /// + /// For example the type of `a` here: + /// + /// ```rust + /// fn foo() -> i32 { 1 } + /// let a: fn() -> i32 = foo; + /// ``` FnPtr(PolyFnSig<'tcx>), /// A trait, defined with `trait`.