doc: make Stack and StackElement a little pretty

Also, fix rustdoc warnings.

1 files changed, 6 insertions, 4 deletions

diff --git a/src/libserialize/json.rs b/src/libserialize/json.rs
index 7565bdeb409..496011b6947 100644
--- a/src/libserialize/json.rs
+++ b/src/libserialize/json.rs
@@ -1417,16 +1417,18 @@ enum ParserState {
 
 /// A Stack represents the current position of the parser in the logical
 /// structure of the JSON stream.
-/// For example foo.bar[3].x
+///
+/// An example is `foo.bar[3].x`.
 pub struct Stack {
     stack: Vec<InternalStackElement>,
     str_buffer: Vec<u8>,
 }
 
 /// StackElements compose a Stack.
-/// For example, StackElement::Key("foo"), StackElement::Key("bar"),
-/// StackElement::Index(3) and StackElement::Key("x") are the
-/// StackElements compositing the stack that represents foo.bar[3].x
+///
+/// As an example, `StackElement::Key("foo")`, `StackElement::Key("bar")`,
+/// `StackElement::Index(3)`, and `StackElement::Key("x")` are the
+/// StackElements compositing the stack that represents `foo.bar[3].x`.
 #[derive(PartialEq, Clone, Debug)]
 pub enum StackElement<'l> {
     Index(u32),