v1.0.0

* @api annotations * Updates README
kzykhys · Dec 1, 2013 · 4914389 · 4914389
1 parent 412c8b2
commit 4914389
Show file tree

Hide file tree

Showing 8 changed files with 47 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -5,8 +5,6 @@ Ciconia - A New Markdown Parser for PHP
 [![Build Status](https://travis-ci.org/kzykhys/Ciconia.png?branch=master)](https://travis-ci.org/kzykhys/Ciconia)
 [![Coverage Status](https://coveralls.io/repos/kzykhys/Ciconia/badge.png?branch=master)](https://coveralls.io/r/kzykhys/Ciconia?branch=master)
 
-**This project is _unstable_** until 1.0.0 (see [milestones][milestones])
-
 The Markdown parser for PHP5.4, it is fully extensible.
 Ciconia is the collection of extension, so you can replace, add or remove each parsing mechanism.
 
@@ -37,7 +35,7 @@ create a `composer.json`
 ``` json
 {
     "require": {
-        "kzykhys/ciconia": "dev-master"
+        "kzykhys/ciconia": "~1.0.0"
     }
 }
 ```
@@ -301,6 +299,6 @@ Kazuyuki Hayashi (@kzykhys)
 
 
 [milestones]: https://github.com/kzykhys/Ciconia/issues/milestones
-[phar]: https://github.com/kzykhys/Ciconia/releases/download/v0.1.7/ciconia.phar
+[phar]: https://github.com/kzykhys/Ciconia/releases/download/v1.0.0/ciconia.phar
 [contributors]: https://github.com/kzykhys/Ciconia/graphs/contributors
 [textapi]: https://github.com/kzykhys/Text#api
diff --git a/src/Ciconia/Ciconia.php b/src/Ciconia/Ciconia.php
@@ -24,7 +24,7 @@
 class Ciconia
 {
 
-    const VERSION = '0.1.7';
+    const VERSION = '1.0.0';
 
     /**
      * @var RendererInterface

diff --git a/src/Ciconia/Event/EmitterAwareInterface.php b/src/Ciconia/Event/EmitterAwareInterface.php
@@ -11,13 +11,17 @@ interface EmitterAwareInterface
 {
 
     /**
+     * @api
+     *
      * @param EmitterInterface $emitter
      *
      * @return mixed
      */
     public function setEmitter(EmitterInterface $emitter);
 
     /**
+     * @api
+     *
      * @return EmitterInterface
      */
     public function getEmitter();

diff --git a/src/Ciconia/Event/EmitterInterface.php b/src/Ciconia/Event/EmitterInterface.php
@@ -13,6 +13,8 @@ interface EmitterInterface
     /**
      * Adds a listener to the end of the listeners array for the specified event.
      *
+     * @api
+     *
      * @param string   $event
      * @param callable $callback
      * @param int      $priority
@@ -24,8 +26,10 @@ public function on($event, callable $callback, $priority = 10);
     /**
      * Execute each of the subscribed listeners
      *
-     * @param $event
-     * @param $parameters
+     * @api
+     *
+     * @param string $event
+     * @param array  $parameters
      *
      * @return mixed
      */

diff --git a/src/Ciconia/Extension/ExtensionInterface.php b/src/Ciconia/Extension/ExtensionInterface.php
@@ -15,6 +15,8 @@ interface ExtensionInterface
     /**
      * Adds listeners to EventEmitter
      *
+     * @api
+     *
      * @param Markdown $markdown
      *
      * @return void
@@ -24,6 +26,8 @@ public function register(Markdown $markdown);
     /**
      * Returns the name of the extension
      *
+     * @api
+     *
      * @return string
      */
     public function getName();

diff --git a/src/Ciconia/Renderer/RendererAwareInterface.php b/src/Ciconia/Renderer/RendererAwareInterface.php
@@ -2,8 +2,6 @@
 
 namespace Ciconia\Renderer;
 
-use Ciconia\Renderer\RendererInterface;
-
 /**
  * RendererAwareInterface should be implemented by extension classes that depends on RendererInterface
  *
@@ -13,11 +11,15 @@ interface RendererAwareInterface
 {
 
     /**
+     * @api
+     *
      * @return RendererInterface
      */
     public function getRenderer();
 
     /**
+     * @api
+     *
      * @param RendererInterface $renderer
      */
     public function setRenderer(RendererInterface $renderer);

diff --git a/src/Ciconia/Renderer/RendererAwareTrait.php b/src/Ciconia/Renderer/RendererAwareTrait.php
@@ -2,8 +2,6 @@
 
 namespace Ciconia\Renderer;
 
-use Ciconia\Renderer\RendererInterface;
-
 /**
  * Implementation of RendererAwareInterface
  *

diff --git a/src/Ciconia/Renderer/RendererInterface.php b/src/Ciconia/Renderer/RendererInterface.php
@@ -14,6 +14,8 @@ interface RendererInterface
 {
 
     /**
+     * @api
+     *
      * @param string|Text $content
      * @param array       $options
      *
@@ -22,6 +24,8 @@ interface RendererInterface
     public function renderParagraph($content, array $options = array());
 
     /**
+     * @api
+     *
      * @param string|Text $content
      * @param array       $options
      *
@@ -30,6 +34,8 @@ public function renderParagraph($content, array $options = array());
     public function renderHeader($content, array $options = array());
 
     /**
+     * @api
+     *
      * @param string|Text $content
      * @param array       $options
      *
@@ -38,6 +44,8 @@ public function renderHeader($content, array $options = array());
     public function renderCodeBlock($content, array $options = array());
 
     /**
+     * @api
+     *
      * @param string|Text $content
      * @param array       $options
      *
@@ -46,6 +54,8 @@ public function renderCodeBlock($content, array $options = array());
     public function renderCodeSpan($content, array $options = array());
 
     /**
+     * @api
+     *
      * @param string|Text $content
      * @param array       $options
      *
@@ -54,6 +64,8 @@ public function renderCodeSpan($content, array $options = array());
     public function renderLink($content, array $options = array());
 
     /**
+     * @api
+     *
      * @param string|Text $content
      * @param array       $options
      *
@@ -62,6 +74,8 @@ public function renderLink($content, array $options = array());
     public function renderBlockQuote($content, array $options = array());
 
     /**
+     * @api
+     *
      * @param string|Text $content
      * @param array       $options
      *
@@ -70,6 +84,8 @@ public function renderBlockQuote($content, array $options = array());
     public function renderList($content, array $options = array());
 
     /**
+     * @api
+     *
      * @param string|Text $content
      * @param array       $options
      *
@@ -78,13 +94,17 @@ public function renderList($content, array $options = array());
     public function renderListItem($content, array $options = array());
 
     /**
+     * @api
+     *
      * @param array $options
      *
      * @return string
      */
     public function renderHorizontalRule(array $options = array());
 
     /**
+     * @api
+     *
      * @param string $src
      * @param array  $options
      *
@@ -93,6 +113,8 @@ public function renderHorizontalRule(array $options = array());
     public function renderImage($src, array $options = array());
 
     /**
+     * @api
+     *
      * @param string|Text $text
      * @param array       $options
      *
@@ -101,6 +123,8 @@ public function renderImage($src, array $options = array());
     public function renderBoldText($text, array $options = array());
 
     /**
+     * @api
+     *
      * @param string|Text $text
      * @param array       $options
      *
@@ -109,6 +133,8 @@ public function renderBoldText($text, array $options = array());
     public function renderItalicText($text, array $options = array());
 
     /**
+     * @api
+     *
      * @param array $options
      *
      * @return string