From 7d910000a2d0408ded2a8ff877b65c400a8115df Mon Sep 17 00:00:00 2001 From: Kevin Sawicki Date: Wed, 20 Aug 2014 12:43:26 -0600 Subject: [PATCH] :memo: Convert DeserializerManager docs --- src/deserializer-manager.coffee | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/deserializer-manager.coffee b/src/deserializer-manager.coffee index 16fa0c442..b9f3745e1 100644 --- a/src/deserializer-manager.coffee +++ b/src/deserializer-manager.coffee @@ -3,7 +3,7 @@ # An instance of this class is always available as the `atom.deserializers` # global. # -# ### Registering a deserializer +# ## Examples # # ```coffee # class MyPackageView extends View @@ -24,21 +24,21 @@ class DeserializerManager # Public: Register the given class(es) as deserializers. # - # classes - One or more classes to register. + # * `classes` One or more classes to register. add: (classes...) -> @deserializers[klass.name] = klass for klass in classes # Public: Remove the given class(es) as deserializers. # - # classes - One or more classes to remove. + # * `classes` One or more classes to remove. remove: (classes...) -> delete @deserializers[name] for {name} in classes # Public: Deserialize the state and params. # - # state - The state {Object} to deserialize. - # params - The params {Object} to pass as the second arguments to the - # deserialize method of the deserializer. + # * `state` The state {Object} to deserialize. + # * `params` The params {Object} to pass as the second arguments to the + # deserialize method of the deserializer. deserialize: (state, params) -> return unless state? @@ -51,7 +51,7 @@ class DeserializerManager # Get the deserializer for the state. # - # state - The state {Object} being deserialized. + # * `state` The state {Object} being deserialized. get: (state) -> return unless state?