about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2017-08-06 12:46:20 +0000
committerbors <bors@rust-lang.org>2017-08-06 12:46:20 +0000
commitbe69520b9ae32c9242207fd5bc97888cd3fc73bf (patch)
treeb6b74a5271eec3cec8f563a9e0e609e7bdbf4035
parenta9c24fd579cfa08852dca94214caae4b7e6b91c1 (diff)
parent068710f28a203dd5edd50aef3b98963073bc3cd9 (diff)
downloadrust-be69520b9ae32c9242207fd5bc97888cd3fc73bf.tar.gz
rust-be69520b9ae32c9242207fd5bc97888cd3fc73bf.zip
Auto merge of #43655 - bjorn3:more_doc_comments, r=arielb1
Make some comments doc comments in librustc/middle/cstore.rs
-rw-r--r--src/librustc/middle/cstore.rs22
1 files changed, 13 insertions, 9 deletions
diff --git a/src/librustc/middle/cstore.rs b/src/librustc/middle/cstore.rs
index b1f4aa69adb..288390cb5e7 100644
--- a/src/librustc/middle/cstore.rs
+++ b/src/librustc/middle/cstore.rs
@@ -18,9 +18,9 @@
 // option. This file may not be copied, modified, or distributed
 // except according to those terms.
 
-// the rustc crate store interface. This also includes types that
-// are *mostly* used as a part of that interface, but these should
-// probably get a better home if someone can find one.
+//! the rustc crate store interface. This also includes types that
+//! are *mostly* used as a part of that interface, but these should
+//! probably get a better home if someone can find one.
 
 use hir::def;
 use hir::def_id::{CrateNum, DefId, DefIndex};
@@ -55,8 +55,8 @@ pub struct LinkMeta {
     pub crate_hash: Svh,
 }
 
-// Where a crate came from on the local filesystem. One of these three options
-// must be non-None.
+/// Where a crate came from on the local filesystem. One of these three options
+/// must be non-None.
 #[derive(PartialEq, Clone, Debug)]
 pub struct CrateSource {
     pub dylib: Option<(PathBuf, PathKind)>,
@@ -120,10 +120,14 @@ pub enum LinkagePreference {
 
 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable)]
 pub enum NativeLibraryKind {
-    NativeStatic,    // native static library (.a archive)
-    NativeStaticNobundle, // native static library, which doesn't get bundled into .rlibs
-    NativeFramework, // macOS-specific
-    NativeUnknown,   // default way to specify a dynamic library
+    /// native static library (.a archive)
+    NativeStatic,
+    /// native static library, which doesn't get bundled into .rlibs
+    NativeStaticNobundle,
+    /// macOS-specific
+    NativeFramework,
+    /// default way to specify a dynamic library
+    NativeUnknown,
 }
 
 #[derive(Clone, Hash, RustcEncodable, RustcDecodable)]