Merge pull request #50 from opentracing/minor_fixes_in_docs

Minor fixes in documentation.

.github/PULL_REQUEST_TEMPLATE.md

@@ -8,7 +8,10 @@ e.g.
 Fixes #1
 Closes #2
 -->
-# Fixes # 
+
+### Short description of what this PR does:
+- 
+- 
 
 ### Checklist
 - [ ] I have made a material change to the repo (functionality, testing, spelling, grammar)
@@ -18,6 +21,4 @@ Closes #2
 - [ ] I have added necessary documentation about the functionality in the appropriate .md file
 - [ ] I have added in line documentation to the code I modified
 
-### Short description of what this PR does:
-- 
-- 
+Closes #

src/OpenTracing/Exceptions/InvalidReferenceArgument.php

@@ -9,11 +9,18 @@
  */
 final class InvalidReferenceArgument extends InvalidArgumentException
 {
+    /**
+     * @return InvalidReferenceArgument
+     */
     public static function forEmptyType()
     {
         return new self('Reference type can not be an empty string');
     }
 
+    /**
+     * @param mixed $context
+     * @return InvalidReferenceArgument
+     */
     public static function forInvalidContext($context)
     {
         return new self(sprintf(

src/OpenTracing/Exceptions/InvalidReferencesSet.php

@@ -9,11 +9,18 @@
  */
 final class InvalidReferencesSet extends DomainException
 {
+    /**
+     * @param string $message
+     * @return InvalidReferencesSet
+     */
     public static function create($message)
     {
         return new self($message);
     }
 
+    /**
+     * @return InvalidReferencesSet
+     */
     public static function forMoreThanOneParent()
     {
         return new self('Span can not have more than one parent, either one as child_of or either one as follows_from');

src/OpenTracing/Exceptions/InvalidSpanOption.php

@@ -9,6 +9,9 @@
  */
 final class InvalidSpanOption extends InvalidArgumentException
 {
+    /**
+     * @return InvalidSpanOption
+     */
     public static function forIncludingBothChildOfAndReferences()
     {
         return new self('Either "childOf" or "references" options are accepted but not both.');

src/OpenTracing/Exceptions/SpanContextNotFound.php

@@ -10,6 +10,9 @@
  */
 final class SpanContextNotFound extends DomainException
 {
+    /**
+     * @return SpanContextNotFound
+     */
     public static function create()
     {
         return new self('SpanContext not found in extract carrier');

src/OpenTracing/GlobalTracer.php

@@ -33,7 +33,7 @@ public static function set(Tracer $tracer)
     public static function get()
     {
         if (self::$instance === null) {
-            self::$instance = Tracer::create();
+            self::$instance = NoopTracer::create();
         }
 
         return self::$instance;

src/OpenTracing/Scope.php

@@ -5,7 +5,6 @@
 /**
  * A {@link Scope} formalizes the activation and deactivation of a {@link Span}, usually from a CPU standpoint.
  *
- * <p>
  * Many times a {@link Span} will be extant (in that {@link Span#finish()} has not been called) despite being in a
  * non-runnable state from a CPU/scheduler standpoint. For instance, a {@link Span} representing the client side of an
  * RPC will be unfinished but blocked on IO while the RPC is still outstanding. A {@link Scope} defines when a given
@@ -17,7 +16,6 @@ interface Scope
      * Mark the end of the active period for the current thread and {@link Scope},
      * updating the {@link ScopeManager#active()} in the process.
      *
-     * <p>
      * NOTE: Calling {@link #close} more than once on a single {@link Scope} instance leads to undefined
      * behavior.
      */

src/OpenTracing/ScopeManager.php

@@ -25,7 +25,6 @@ public function activate(Span $span);
      * Return the currently active {@link Scope} which can be used to access the currently active
      * {@link Scope#getSpan()}.
      *
-     * <p>
      * If there is an {@link Scope non-null scope}, its wrapped {@link Span} becomes an implicit parent
      * (as {@link References#CHILD_OF} reference) of any
      * newly-created {@link Span} at {@link Tracer.SpanBuilder#startActive(boolean)} or {@link SpanBuilder#start()}

src/OpenTracing/Tracer.php

@@ -95,12 +95,12 @@ public function extract($format, $carrier);
      * Allow tracer to send span data to be instrumented.
      *
      * This method might not be needed depending on the tracing implementation
-     * but one should make sure this method is called after the request is finished.
-     * As an implementor, a good idea would be to use register_shutdown_function
-     * or fastcgi_finish_request in order to not to delay the end of the request to the client.
+     * but one should make sure this method is called after the request is delivered
+     * to the client.
      *
-     * @see register_shutdown_function()
-     * @see fastcgi_finish_request()
+     * As an implementor, a good idea would be to use {@see register_shutdown_function}
+     * or {@see fastcgi_finish_request} in order to not to delay the end of the request
+     * to the client.
      */
     public function flush();
 }