Skip to content

Commit

Permalink
Add variable name back to @param tag
Browse files Browse the repository at this point in the history
  • Loading branch information
Eliezer Kanal committed Mar 25, 2014
1 parent a60620d commit ed604de
Show file tree
Hide file tree
Showing 7 changed files with 70 additions and 69 deletions.
Expand Up @@ -23,10 +23,10 @@ interface tubepress_api_event_EventDispatcherInterface
/**
* Adds an event listener that listens on the specified events.
*
* @param string The event to listen on
* @param callable The listener
* @param integer The higher this value, the earlier an event
* listener will be triggered in the chain (defaults to 0)
* @param string $eventName The event to listen on
* @param callable $listener The listener
* @param integer $priority The higher this value, the earlier an event
* listener will be triggered in the chain (defaults to 0)
*
* @api
* @since 3.1.0
Expand All @@ -36,11 +36,12 @@ function addListener($eventName, $listener, $priority = 0);
/**
* Adds a service as event listener
*
* @param string Event for which the listener is added
* @param array The service ID of the listener service & the method
* name that has to be called
* @param integer The higher this value, the earlier an event listener
* will be triggered in the chain. Defaults to 0.
* @param string $eventName Event for which the listener is added
* @param array $callback The service ID of the listener service & the method
* name that has to be called
* @param integer $priority The higher this value, the earlier an event listener
* will be triggered in the chain.
* Defaults to 0.
*
* @throws InvalidArgumentException
*
Expand All @@ -52,11 +53,11 @@ function addListenerService($eventName, $callback, $priority = 0);
/**
* Dispatches an event to all registered listeners.
*
* @param string The name of the event to dispatch. The name of
* the event is the name of the method that is
* invoked on listeners.
* @param tubepress_api_event_EventInterface The event to pass to the event handlers/listeners.
* If not supplied, an empty event instance is created.
* @param string $eventName The name of the event to dispatch. The name of
* the event is the name of the method that is
* invoked on listeners.
* @param tubepress_api_event_EventInterface $event The event to pass to the event handlers/listeners.
* If not supplied, an empty event instance is created.
*
* @return tubepress_api_event_EventInterface
*
Expand All @@ -68,7 +69,7 @@ function dispatch($eventName, tubepress_api_event_EventInterface $event = null);
/**
* Gets the listeners of a specific event or all listeners.
*
* @param string The name of the event
* @param string $eventName The name of the event
*
* @return array The event listeners for the specified event, or all event listeners by event name
*
Expand All @@ -80,7 +81,7 @@ function getListeners($eventName = null);
/**
* Checks whether an event has any registered listeners.
*
* @param string The name of the event
* @param string $eventName The name of the event
*
* @return Boolean true if the specified event has any listeners, false otherwise
*
Expand All @@ -92,8 +93,8 @@ function hasListeners($eventName = null);
/**
* Removes an event listener from the specified events.
*
* @param string|array The event(s) to remove a listener from
* @param callable The listener to remove
* @param string|array $eventName The event(s) to remove a listener from
* @param callable $listener The listener to remove
*
* @api
* @since 3.1.0
Expand Down
12 changes: 6 additions & 6 deletions src/main/php/classes/tubepress/api/event/EventInterface.php
Expand Up @@ -24,7 +24,7 @@ interface tubepress_api_event_EventInterface
/**
* Get argument by key.
*
* @param string Key.
* @param string $key Key.
*
* @throws InvalidArgumentException If key is not found.
*
Expand Down Expand Up @@ -76,7 +76,7 @@ function getSubject();
/**
* Has argument.
*
* @param string Key of arguments array.
* @param string $key Key of arguments array.
*
* @return boolean
*
Expand All @@ -98,8 +98,8 @@ function isPropagationStopped();
/**
* Add argument to event.
*
* @param string Argument name.
* @param mixed Value.
* @param string $key Argument name.
* @param mixed $value Value.
*
* @return tubepress_api_event_EventInterface
*
Expand All @@ -111,7 +111,7 @@ function setArgument($key, $value);
/**
* Add numerous arguments to an event.
*
* @param array Arguments. Both the key and value of the array elements are used in setting the arguments.
* @param array $args Arguments. Both the key and value of the array elements are used in setting the arguments.
*
* @return tubepress_api_event_EventInterface
*
Expand All @@ -123,7 +123,7 @@ function setArguments(array $args = array());
/**
* Allows listeners to replace the subject with a new item.
*
* @param mixed The new subject for the event.
* @param mixed $subject The new subject for the event.
*
* @return void
*
Expand Down
Expand Up @@ -18,7 +18,7 @@ interface tubepress_api_ioc_CompilerPassInterface
* Provides add-ons with the ability to modify the TubePress IOC container builder
* before it is compiled for production.
*
* @param tubepress_api_ioc_ContainerBuilderInterface The core IOC container builder.
* @param tubepress_api_ioc_ContainerBuilderInterface $containerBuilder The core IOC container builder.
*
* @api
* @since 3.1.0
Expand Down
Expand Up @@ -19,7 +19,7 @@ interface tubepress_api_ioc_ContainerBuilderInterface
/**
* Adds the service definitions.
*
* @param tubepress_api_ioc_DefinitionInterface[] An array of service definitions
* @param tubepress_api_ioc_DefinitionInterface[] $definitions An array of service definitions
*
* @return void
*
Expand All @@ -31,7 +31,7 @@ function addDefinitions(array $definitions);
/**
* Returns service ids for a given tag.
*
* @param string The tag name
* @param string $name The tag name
*
* @return array An array of tags
*
Expand All @@ -53,7 +53,7 @@ function findTags();
/**
* Gets a service.
*
* @param string The service identifier
* @param string $id The service identifier
*
* @return object The associated service, or null if not defined.
*
Expand All @@ -65,7 +65,7 @@ function get($id);
/**
* Gets a service definition.
*
* @param string The service identifier
* @param string $id The service identifier
*
* @return tubepress_api_ioc_DefinitionInterface A `tubepress_api_ioc_DefinitionInterface` instance, or null if the
* service does not exist.
Expand All @@ -88,7 +88,7 @@ function getDefinitions();
/**
* Gets a parameter.
*
* @param string The parameter name
* @param string $name The parameter name
*
* @return mixed The parameter value
*
Expand All @@ -112,7 +112,7 @@ function getServiceIds();
/**
* Returns true if the given service is defined.
*
* @param string The service identifier
* @param string $id The service identifier
*
* @return Boolean true if the service is defined, false otherwise
*
Expand All @@ -124,7 +124,7 @@ function has($id);
/**
* Returns true if a service definition exists under the given identifier.
*
* @param string The service identifier
* @param string $id The service identifier
*
* @return Boolean true if the service definition exists, false otherwise
*
Expand All @@ -136,7 +136,7 @@ function hasDefinition($id);
/**
* Checks if a parameter exists.
*
* @param string The parameter name
* @param string $name The parameter name
*
* @return Boolean The presence of parameter in container
*
Expand All @@ -148,7 +148,7 @@ function hasParameter($name);
/**
* Check for whether or not a service has been initialized.
*
* @param string Name of the service to be verified
* @param string $id Name of the service to be verified
*
* @return Boolean true if the service has been initialized, false otherwise
*
Expand All @@ -163,8 +163,8 @@ function initialized($id);
* This methods allows for simple registration of service definition
* with a fluid interface.
*
* @param string The service identifier
* @param string The service class
* @param string $id The service identifier
* @param string $class The service class
*
* @return tubepress_api_ioc_DefinitionInterface A `tubepress_api_ioc_DefinitionInterface` instance
*
Expand All @@ -176,7 +176,7 @@ function register($id, $class = null);
/**
* Removes a service definition.
*
* @param string The service identifier
* @param string $id The service identifier
*
* @return void
*
Expand All @@ -188,8 +188,8 @@ function removeDefinition($id);
/**
* Sets a service.
*
* @param string The service identifier
* @param object The service instance
* @param string $id The service identifier
* @param object $service The service instance
*
* @return void
*
Expand All @@ -201,8 +201,8 @@ function set($id, $service);
/**
* Sets a service definition.
*
* @param string The service identifier
* @param tubepress_api_ioc_DefinitionInterface A `tubepress_api_ioc_DefinitionInterface` instance
* @param string $id The service identifier
* @param tubepress_api_ioc_DefinitionInterface $definition A `tubepress_api_ioc_DefinitionInterface` instance
*
* @return tubepress_api_ioc_DefinitionInterface the service definition
*
Expand All @@ -216,7 +216,7 @@ function setDefinition($id, tubepress_api_ioc_DefinitionInterface $definition);
/**
* Sets the service definitions.
*
* @param tubepress_api_ioc_DefinitionInterface[] An array of service definitions
* @param tubepress_api_ioc_DefinitionInterface[] $definitions An array of service definitions
*
* @return void
*
Expand All @@ -228,8 +228,8 @@ function setDefinitions(array $definitions);
/**
* Sets a parameter.
*
* @param string The parameter name
* @param mixed The parameter value
* @param string $name The parameter name
* @param mixed $value The parameter value
*
* @return void
*
Expand Down
Expand Up @@ -22,7 +22,7 @@ interface tubepress_api_ioc_ContainerExtensionInterface
/**
* Allows extensions to load services into the TubePress IOC container.
*
* @param tubepress_api_ioc_ContainerBuilderInterface A `tubepress_api_ioc_ContainerBuilderInterface` instance.
* @param tubepress_api_ioc_ContainerBuilderInterface $containerBuilderBuilder A `tubepress_api_ioc_ContainerBuilderInterface` instance.
*
* @return void
*
Expand Down

0 comments on commit ed604de

Please sign in to comment.