Update code docs

0exp · Apr 12, 2018 · d4241eb · d4241eb
1 parent 9c9a13d
commit d4241eb
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 12 deletions.
diff --git a/lib/evil_events/core/broadcasting/emitter.rb b/lib/evil_events/core/broadcasting/emitter.rb
@@ -5,8 +5,9 @@ module EvilEvents::Core::Broadcasting
   # @since 0.1.0
   class Emitter
     # @param event [EvilEvents::Core::Events::AbstractEvent]
+    # @option adapter [Symbol,NilClass]
     # @raise [EvilEvents::IncorrectEventForEmitError]
-    # @return void
+    # @return [void]
     #
     # @since 0.1.0
     def emit(event, adapter: nil)
@@ -21,8 +22,11 @@ def emit(event, adapter: nil)
     end
 
     # @param event_type [String]
-    # @param event_attributes [Hash]
-    # @return void
+    # @option id [NilClass,String]
+    # @option payload [Hash]
+    # @option metadata [Hash]
+    # @option adapter [Symbol,NilClass]
+    # @return [void]
     #
     # @since 0.1.0
     def raw_emit(event_type, id: nil, payload: {}, metadata: {}, adapter: nil)
@@ -37,7 +41,7 @@ def raw_emit(event_type, id: nil, payload: {}, metadata: {}, adapter: nil)
 
     # @param event [EvilEvents::Core::Events::AbstractEvent]
     # @param adapter_proxy [EvilEvents::Core::Broadcasting::Emitter::AdapterProxy]
-    # @return void
+    # @return [void]
     #
     # @since 0.1.0
     def log_activity(event, adapter_proxy)

diff --git a/lib/evil_events/core/broadcasting/emitter/adapter_proxy.rb b/lib/evil_events/core/broadcasting/emitter/adapter_proxy.rb
@@ -11,7 +11,7 @@ class AdapterProxy
     attr_reader :identifier
 
     # @param event [EvilEvents::Core::Events::AbstractEvent]
-    # @param explicit_identifier [Symbol,NilClass]
+    # @option explicit_identifier [Symbol,NilClass]
     #
     # @api private
     # @since 0.4.0

diff --git a/lib/evil_events/core/events/event_extensions/dispatchable.rb b/lib/evil_events/core/events/event_extensions/dispatchable.rb
@@ -14,21 +14,22 @@ def included(base_class)
       end
     end
 
-    # @return [EvilEvents::Core::Broadcasting::Dispatcher::Dispatchable]
+    # @return [EvilEvents::Core::Broadcasting::Dispatcher::Mixin]
     #
     # @since 0.4.0
     def adapter
       self.class.adapter
     end
 
-    # @return [EvilEvents::Core::Broadcasting::Dispatcher::Dispatchable]
+    # @return [EvilEvents::Core::Broadcasting::Dispatcher::Mixin]
     #
     # @since 0.4.0
     def adapter_name
       self.class.adapter_name
     end
 
-    # @return void
+    # @option adapter [Symbol,NilClass]
+    # @return [void]
     #
     # @api public
     # @since 0.4.0
@@ -38,7 +39,7 @@ def emit!(adapter: nil)
 
     # @since 0.4.0
     module ClassMethods
-      # @param identifier [Symbol, String]
+      # @param identifier [Symbol,String,NilClass]
       # @return [EvilEvents::Core::Broadcasting::Dispatcher::Dispatchable]
       #
       # @since 0.4.0
@@ -54,10 +55,11 @@ def adapter_name
         @adapter_identifier || EvilEvents::Core::Bootstrap[:config].adapter.default
       end
 
-      # @option id [NilClass, Object]
+      # @option id [NilClass,Object]
       # @option payload [Hash]
       # @option metadata [Hash]
-      # @return void
+      # @option adapter [Symbol,NilClass]
+      # @return [void]
       #
       # @see EvilEvents::Core::Events::AbstractEvent#initialize
       # @see EvilEvents::Core::Events::EventExtensions::Emittable#emit!

diff --git a/lib/evil_events/core/system/broadcaster.rb b/lib/evil_events/core/system/broadcaster.rb
@@ -29,6 +29,7 @@ def initialize
     end
 
     # @param event [EvilEvents::Core::Events::AbstractEvent]
+    # @option adapter [Symbol,NilClass]
     # @return void
     #
     # @since 0.1.0
@@ -37,7 +38,10 @@ def emit(event, adapter: nil)
     end
 
     # @param event_type [String]
-    # @param event_attributes [Hash]
+    # @option id [NilClass,String]
+    # @option payload [Hash]
+    # @option metadata [Hash]
+    # @option adapter [Symbol,NilClass]
     # @return void
     #
     # @since 0.1.0