update docs

docs/10_Description.md

@@ -2,17 +2,18 @@
 
 AdminLTE is a Bootstrap based framework to create admin like webinterfaces.
 
-Two entry points for AdminLTE are:
+To get an inpression: 2 entry points for AdminLTE are:
 
 * source: <https://adminlte.io/themes/v3/starter.html>
 * docs:   <https://adminlte.io/docs/3.2/index.html>
 
-The AdminLTE renderer class offers several methods to render 
+The AdminLTE renderer class offers several methods to render
 
 * the page
 * layout elements
 * components you can use on the page
   * navigation
+  * grid
   * boxes
   * buttons
   * ...

docs/30_Page_layout.md

@@ -4,10 +4,10 @@ See file public_html/config/**00_page.tpl.php** - this is a basic page created f
 
 ### Helper variables
 
-Variable                | Description                                 | Example
----                     |---                                          |---
-{{DIR_ADMINLTE}}        | base path to find AdminLTE resources        | `/vendor/admin-lte/3.2.0`
-{{DIR_ADMINLTEPLUGINS}} | base path for bootstrp, jquery, fontawesome | `/vendor/admin-lte-plugins`
+Variable                | Description                                  | Example
+---                     |---                                           |---
+{{DIR_ADMINLTE}}        | base path to find AdminLTE resources         | `/vendor/admin-lte/3.2.0`
+{{DIR_ADMINLTEPLUGINS}} | base path for bootstrap, jquery, fontawesome | `/vendor/admin-lte-plugins`
 
 ### Layout
 

docs/50_Components/10_Grid.md

@@ -10,6 +10,10 @@ You can use muliple rows ... and divide each row in multiple columns. The grid c
 $renderAdminLTE->addRow([HTML code]);
 ```
 
+### Return
+
+{string} html code
+
 ### Parameters
 
 * [HTML code] - {string} Html code of the visible content

docs/50_Components/Alert.md

@@ -8,6 +8,10 @@ An alert is a colored box with title and text.
 $renderAdminLTE->getAlert($aOptions);
 ```
 
+### Return
+
+{string} html code
+
 ### Parameters
 
 * $aOptions - {array} options to describe the element

docs/50_Components/Badge.md

@@ -8,6 +8,10 @@ A badge is a small counter or info next to a text info,
 $renderAdminLTE->getBadge($aOptions);
 ```
 
+### Return
+
+{string} html code
+
 ### Parameters
 
 * $aOptions - {array} options to describe the element

docs/50_Components/Button.md

@@ -11,6 +11,10 @@ You can use any other key that are not named here. Those keys will be rendered a
 $renderAdminLTE->getButton($aOptions);
 ```
 
+### Return
+
+{string} html code
+
 ### Parameters
 
 * $aOptions - {array} options to describe the element

docs/50_Components/Callout.md

@@ -8,6 +8,10 @@ A box with colored left border. It has type, title + text.
 $renderAdminLTE->getCallout($aOptions);
 ```
 
+### Return
+
+{string} html code
+
 ### Parameters
 
 * $aOptions - {array} options to describe the element

docs/50_Components/Card.md

@@ -10,6 +10,10 @@ It has header, main text and a footer.
 $renderAdminLTE->getCard($aOptions);
 ```
 
+### Return
+
+{string} html code
+
 ### Parameters
 
 * $aOptions - {array} options to describe the element
@@ -21,6 +25,19 @@ Key      | Description
 class    | optional: additional css classes
 type     | one of [none]\|danger\|dark\|info\|primary\|secondary\|success\|warning
 variant  | kind of coloring: one of<br>- "default"  - titlebar is colored<br>- "outline" - a small stripe on top border is colored<br>- "solid"    - whole card is colored<br>- "gradient" - whole card is colored with a gradient
+state    | window state. one of [none]\|collapsed\|maximized
+
+Toolbar icons:
+
+Set to true to show it; default: none of it is visible
+
+Key         | Description
+---         | ---
+tb-collaps  | 
+tb-expand   | it is added automatically if you set 'state'=>'collapsed'
+tb-maximize |
+tb-minimize | it is added automatically if you set 'state'=>'maximized'
+tb-remove   | 
 
 Content:
 

docs/50_Components/Infobox.md

@@ -8,6 +8,10 @@ A div box - kind of a tile - to show an icon, text, value; optional with a progr
 $renderAdminLTE->getCard($aOptions);
 ```
 
+### Return
+
+{string} html code
+
 ### Parameters
 
 * $aOptions - {array} options to describe the element

docs/_index.md

@@ -2,7 +2,7 @@
 <div class="hero">
 
   <h2>AdminLTE 3 :: Renderer</h2>
-  PHP class to render elements of AdminLTE template
+  PHP class to render elements of the AdminLTE template
 
 </div>
 </html>

docs/config.json

 {
     "title": "AdminLTE renderer",
     "author": "Axel Hahn",
-    "tagline": "PHP class to render elements of AdminLTE template",
+    "tagline": "PHP class to render elements of the AdminLTE template",
     "ignore": {
         "files": ["_skeleton.md"],
         "folders": ["99_Not_Ready"]