From c2fa20c543987f7e282188bfe3fc71ed1cfc8fb2 Mon Sep 17 00:00:00 2001
From: Kevin Sawicki <kevin@github.com>
Date: Wed, 20 Aug 2014 12:25:35 -0600
Subject: [PATCH] :memo: Convert Clipboard docs

---
 src/clipboard.coffee | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/src/clipboard.coffee b/src/clipboard.coffee
index c717350ae..03d53d574 100644
--- a/src/clipboard.coffee
+++ b/src/clipboard.coffee
@@ -4,6 +4,14 @@ crypto = require 'crypto'
 # Public: Represents the clipboard used for copying and pasting in Atom.
 #
 # An instance of this class is always available as the `atom.clipboard` global.
+#
+# ## Examples
+#
+# ```coffee
+# atom.clipboard.write('hello')
+#
+# console.log(atom.clipboard.read()) # 'hello'
+# ```
 module.exports =
 class Clipboard
   metadata: null
@@ -11,7 +19,7 @@ class Clipboard
 
   # Creates an `md5` hash of some text.
   #
-  # text - A {String} to hash.
+  # * `text` A {String} to hash.
   #
   # Returns a hashed {String}.
   md5: (text) ->
@@ -22,8 +30,8 @@ class Clipboard
   # The metadata associated with the text is available by calling
   # {::readWithMetadata}.
   #
-  # text - The {String} to store.
-  # metadata - The additional info to associate with the text.
+  # * `text` The {String} to store.
+  # * `metadata` The additional info to associate with the text.
   write: (text, metadata) ->
     @signatureForMetadata = @md5(text)
     @metadata = metadata
@@ -39,8 +47,8 @@ class Clipboard
   # associated metadata.
   #
   # Returns an {Object} with the following keys:
-  #   :text - The {String} clipboard text.
-  #   :metadata - The metadata stored by an earlier call to {::write}.
+  #   * `text` The {String} clipboard text.
+  #   * `metadata` The metadata stored by an earlier call to {::write}.
   readWithMetadata: ->
     text = @read()
     if @signatureForMetadata is @md5(text)