.

greg-md · Jan 22, 2017 · b681c17 · b681c17
1 parent 7d753a4
commit b681c17
Show file tree

Hide file tree

Showing 30 changed files with 223 additions and 72 deletions.
diff --git a/docs/Accessor/AccessorStaticTrait.md b/docs/Accessor/AccessorStaticTrait.md
@@ -22,6 +22,10 @@ class InMemory
 }
 ```
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
 * [getAccessor](#getaccessor) - Get storage;

diff --git a/docs/Accessor/AccessorTrait.md b/docs/Accessor/AccessorTrait.md
@@ -32,6 +32,10 @@ class Options
 }
 ```
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
 * [getAccessor](#getaccessor) - Get storage;

diff --git a/docs/Accessor/ArrayAccessStaticTrait.md b/docs/Accessor/ArrayAccessStaticTrait.md
@@ -1,8 +1,9 @@
 # ArrayAccessStaticTrait Documentation
 
-A trait for **public** usage of the storage in a static class.
+`\Greg\Support\Accessor\ArrayAccessStaticTrait` is a trait for **public** usage of the storage in a static class.
 
-Use: [`\Greg\Support\Accessor\AccessorStaticTrait`](AccessorStaticTrait.md), [`\Greg\Support\Accessor\ArrayAccessorStaticTrait`](ArrayAccessorStaticTrait.md).
+Uses: [`\Greg\Support\Accessor\AccessorStaticTrait`](AccessorStaticTrait.md),
+      [`\Greg\Support\Accessor\ArrayAccessorStaticTrait`](ArrayAccessorStaticTrait.md).
 
 _Example:_
 
@@ -13,6 +14,11 @@ class Storage
 }
 ```
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
-See trait uses.
+Includes [AccessorStaticTrait](AccessorStaticTrait.md)
+         and [ArrayAccessorStaticTrait](ArrayAccessorStaticTrait.md) methods.
diff --git a/docs/Accessor/ArrayAccessTrait.md b/docs/Accessor/ArrayAccessTrait.md
@@ -1,8 +1,10 @@
 # ArrayAccessTrait Documentation
 
-A trait for **public** usage of the storage in a class with [`\ArrayAccess`](http://php.net/manual/en/class.arrayaccess.php) support.
+`\Greg\Support\Accessor\ArrayAccessTrait` is a trait for **public** usage of the storage in a class
+    with [`\ArrayAccess`](http://php.net/manual/en/class.arrayaccess.php) support.
 
-Use: [`\Greg\Support\Accessor\AccessorTrait`](AccessorTrait.md), [`\Greg\Support\Accessor\ArrayAccessorTrait`](ArrayAccessorTrait.md).
+Uses: [`\Greg\Support\Accessor\AccessorTrait`](AccessorTrait.md),
+      [`\Greg\Support\Accessor\ArrayAccessorTrait`](ArrayAccessorTrait.md).
 
 _Example:_
 
@@ -13,6 +15,12 @@ class Storage implements \ArrayAccess
 }
 ```
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
-See trait uses.
+Includes [AccessorTrait](AccessorTrait.md),
+         [ArrayAccessorTrait](ArrayAccessorTrait.md)
+         and [`\ArrayAccess`](http://php.net/manual/en/class.arrayaccess.php) methods.
diff --git a/docs/Accessor/ArrayAccessorStaticTrait.md b/docs/Accessor/ArrayAccessorStaticTrait.md
@@ -18,6 +18,10 @@ class Storage
 }
 ```
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
 * [has](#has) - Determine if a key or an array of keys exists in accessor;

diff --git a/docs/Accessor/ArrayAccessorTrait.md b/docs/Accessor/ArrayAccessorTrait.md
@@ -18,6 +18,10 @@ class Storage
 }
 ```
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
 * [has](#has) - Determine if a key or an array of keys exists in accessor;

diff --git a/docs/Accessor/ArrayObject.md b/docs/Accessor/ArrayObject.md
@@ -2,8 +2,34 @@
 
 `\Greg\Support\Accessor\ArrayObject` is an array as an object.
 
+Implements: [`\ArrayAccess`](http://php.net/manual/en/class.arrayaccess.php),
+            [`\IteratorAggregate`](http://php.net/manual/en/class.iteratoraggregate.php),
+            [`\Serializable`](http://php.net/manual/en/class.serializable.php),
+            [`\Countable`](http://php.net/manual/en/class.countable.php).
+
+Uses: [`\Greg\Support\Accessor\ArrayAccessTrait`](ArrayAccessTrait.md),
+      [`\Greg\Support\Accessor\IteratorAggregateTrait`](IteratorAggregateTrait.md),
+      [`\Greg\Support\Accessor\SerializableTrait`](SerializableTrait.md),
+      [`\Greg\Support\Accessor\CountableTrait`](CountableTrait.md).
+
+# Table of contents:
+
+* [Magic methods](#magic-methods)
+* [Methods](#methods)
+
+# Magic methods:
+
+* [__construct](#__construct);
+
+**Methods description is under construction.**
+
 # Methods:
 
+Includes [ArrayAccessTrait](ArrayAccessTrait.md),
+         [IteratorAggregateTrait](IteratorAggregateTrait.md),
+         [SerializableTrait](SerializableTrait.md)
+         and [CountableTrait](CountableTrait.md) methods.
+
 * [toArray](#toarray) - Transform to array;
 * [exchange](#exchange) - Exchange array;
 * [exchangeRef](#exchangeref) - Exchange array reference;
@@ -60,8 +86,4 @@
 * [keys](#keys) - Get keys of array;
 * [values](#values) - Get values of array.
 
-**Magic methods:**
-
-* [__construct](#__construct);
-
 **Methods description is under construction.**
diff --git a/docs/Accessor/CountableTrait.md b/docs/Accessor/CountableTrait.md
@@ -1,6 +1,6 @@
 # CountableTrait Documentation
 
-A trait for [Countable](http://php.net/manual/en/class.countable.php) interface.
+A trait for [`\Countable`](http://php.net/manual/en/class.countable.php) interface.
 
 _Example:_
 
@@ -18,6 +18,10 @@ class Storage implements \Countable
 }
 ```
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
-See [Countable](http://php.net/manual/en/class.countable.php) interface.
+Includes [`\Countable`](http://php.net/manual/en/class.countable.php) methods.
diff --git a/docs/Accessor/IteratorAggregateTrait.md b/docs/Accessor/IteratorAggregateTrait.md
@@ -1,6 +1,6 @@
 # IteratorAggregateTrait Documentation
 
-A trait for [IteratorAggregate](http://php.net/manual/en/class.iteratoraggregate.php) interface.
+A trait for [`\IteratorAggregate`](http://php.net/manual/en/class.iteratoraggregate.php) interface.
 
 _Example:_
 
@@ -18,9 +18,13 @@ class Storage implements \IteratorAggregate
 }
 ```
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
-See [IteratorAggregate](http://php.net/manual/en/class.iteratoraggregate.php) interface.
+Includes [`\IteratorAggregate`](http://php.net/manual/en/class.iteratoraggregate.php) methods.
 
 * [getIteratorClass](#getiteratorclass) - Get iterator class;
 * [setIteratorClass](#setiteratorclass) - Set iterator class.

diff --git a/docs/Accessor/SerializableTrait.md b/docs/Accessor/SerializableTrait.md
@@ -1,6 +1,6 @@
 # SerializableTrait Documentation
 
-A trait for [SerializableTrait](http://php.net/manual/en/class.serializable.php) interface.
+A trait for [`\Serializable`](http://php.net/manual/en/class.serializable.php) interface.
 
 _Example:_
 
@@ -25,6 +25,10 @@ class Storage implements \Serializable
 }
 ```
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
-See [SerializableTrait](http://php.net/manual/en/class.serializable.php) interface.
+Includes [`\Serializable`](http://php.net/manual/en/class.serializable.php) methods.
diff --git a/docs/Arr.md b/docs/Arr.md
@@ -2,6 +2,11 @@
 
 `\Greg\Support\Arr` is working with arrays.
 
+# Table of contents:
+
+* [Constants](#constants)
+* [Methods](#methods)
+
 # Constants:
 
 ```php

diff --git a/docs/Config.md b/docs/Config.md
@@ -2,6 +2,10 @@
 
 `\Greg\Support\Config` is working with config files.
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
 * [dir](#dir) - Get a config from a directory;

diff --git a/docs/DateTime.md b/docs/DateTime.md
@@ -4,8 +4,14 @@
 
 Extends: [`\DateTime`](http://php.net/manual/en/class.datetime.php).
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
+Includes [`\DateTime`](http://php.net/manual/en/class.datetime.php) methods.
+
 * [yearInterval](#yearinterval) - Get a string interval to current year;
 * [transform](#transform) - Transform a time;
 * [transformLocale](#transformlocale) - Transform a time, using locale;

diff --git a/docs/Dir.md b/docs/Dir.md
@@ -2,6 +2,10 @@
 
 `\Greg\Support\Dir` is working with directories.
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
 * [make](#make) - Make a directory;

diff --git a/docs/File.md b/docs/File.md
@@ -2,6 +2,17 @@
 
 `\Greg\Support\File` is working with directories.
 
+# Table of contents:
+
+* [Magic methods](#magic-methods)
+* [Methods](#methods)
+
+# Magic methods:
+
+* [__construct](#__construct);
+
+**Methods description is under construction.**
+
 # Methods:
 
 * [fileName](#filename) - Get file name;
@@ -13,8 +24,4 @@
 * [mime](#mime) - Get mime of a file;
 * [makeDir](#makedir) - Make directory of a file.
 
-**Magic methods:**
-
-* [__construct](#__construct);
-
 **Methods description is under construction.**
diff --git a/docs/Http/Request.md b/docs/Http/Request.md
@@ -4,6 +4,12 @@
 
 Throws: `\Greg\Support\Http\RequestException`.
 
+# Table of contents:
+
+* [Constants](#constants)
+* [Magic methods](#magic-methods)
+* [Methods](#methods)
+
 # Constants
 
 ```php
@@ -37,6 +43,12 @@ const UPLOAD_ERROR = [
 ];
 ```
 
+# Magic methods:
+
+* [__construct](#__construct);
+
+**Methods description is under construction.**
+
 # Methods:
 
 * [validate](#validate) - Validate params;
@@ -90,8 +102,4 @@ const UPLOAD_ERROR = [
 * [fileIndex](#fileindex) - Get a param or an array of params by index from `$_FILES`;
 * [fileIndexArray](#fileindexarray) - Get an array param or an array of array params by index from `$_FILES`.
 
-**Magic methods:**
-
-* [__construct](#__construct);
-
 **Methods description is under construction.**
diff --git a/docs/Http/Response.md b/docs/Http/Response.md
@@ -4,6 +4,12 @@
 
 Throws: `\Greg\Support\Http\ResponseException`.
 
+# Table of contents:
+
+* [Constants](#constants)
+* [Magic methods](#magic-methods)
+* [Methods](#methods)
+
 # Constants
 
 ```php
@@ -71,6 +77,13 @@ const CODES = [
 ];
 ```
 
+# Magic methods
+
+* [__construct](#__construct);
+* [__toString](#__toString);
+
+**Methods description is under construction.**
+
 # Methods:
 
 * [back](#back) - Set redirection back;
@@ -111,9 +124,4 @@ const CODES = [
 * [flush](#flush) - Flush the output buffer;
 * [isModifiedSince](#ismodifiedsince) - Determine if the request was modified.
 
-**Magic methods**
-
-* [__construct](#__construct);
-* [__toString](#__toString);
-
 **Methods description is under construction.**
diff --git a/docs/Image.md b/docs/Image.md
@@ -4,8 +4,14 @@
 
 Extends: [`\Greg\Support\File`](File.md).
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
+Includes [File](File.md) methods.
+
 * [getType](#gettype) - Get image type;
 * [getSize](#getsize) - Get image size;
 * [getResource](#getresource) - Get image resource;
@@ -17,8 +23,4 @@ Extends: [`\Greg\Support\File`](File.md).
 * [width](#width) - Get width of an image;
 * [height](#height) - Get height of an image.
 
-**Magic methods:**
-
-* [__construct](#__construct);
-
 **Methods description is under construction.**
diff --git a/docs/Obj.md b/docs/Obj.md
@@ -2,6 +2,10 @@
 
 `\Greg\Support\Obj` is working with objects.
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
 * [call](#call) - Call a callable with arguments;

diff --git a/docs/Server.md b/docs/Server.md
@@ -2,6 +2,10 @@
 
 `\Greg\Support\Server` is working with server configurations.
 
+# Table of contents:
+
+* [Methods](#methods)
+
 # Methods:
 
 * [scriptName](#scriptname) - Get script name;