   # 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

  # associated metadata.
  #
  # Returns an {Object} with the following keys:
  #   :text - The {String} clipboard text.
  #   :metadata - The metadata stored by an earlier call to {::write}.
  readWithMetadata: ->
    text = @read()
    if @signatureForMetadata is @md5(text)

# 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
