Add template

template.xml with Twig transformation.
Twig template for classes.

Author: cvuorinen

data/templates/markdown-public/class.md.twig

@@ -0,0 +1,85 @@
+## {{ class.name }}
+
+{{ class.summary|raw }}
+
+{{ class.description|raw }}
+
+* Full name: {{ class.FullyQualifiedStructuralElementName }}
+{% if class.parent %}* Parent class: {{ class.parent.FullyQualifiedStructuralElementName }}
+{% endif %}
+{% if class.interfaces is not empty %}* This class implements: {{ class.interfaces|join(', ')|raw }}
+{% endif %}
+{% if class.deprecated %}* **Warning:** this class is **deprecated**. This means that this class will likely be removed in a future version.
+{% endif %}
+
+{% if class.tags.see is not empty or class.tags.link is not empty %}
+**See Also:**
+
+{% for see in class.tags.see %}
+* {{ see.reference }} {% if see.description %}- {{ see.description|raw }}{% endif %}
+{% endfor %}
+{% for link in class.tags.link %}
+* {{ link.link }} {% if link.description and link.description != link.link %}- {{ link.description|raw }}{% endif %}
+{% endfor %}
+
+{% endif %}{# class.tags.see || class.tags.link #}
+
+{% set specialMethods = class.magicMethods ? class.inheritedMethods.merge(class.magicMethods) : class.inheritedMethods %}
+{% for method in class.methods.merge(specialMethods) %}
+{% if method.visibility == 'public' %}
+
+### {{ method.name }}
+
+{{ method.summary|raw }}
+
+{# Method signature #}
+```php
+{{ class.name }}::{{ method.name }}( {% for argument in method.arguments %}
+{{- argument.types ? argument.types|join('|')~' ' }}
+{{- argument.byReference ? '&' }}
+{{- argument.name }}{{ argument.default ? ' = '~argument.default }}
+{%- if not loop.last %}, {% endif %}
+{%- endfor %} )
+{{- method.response.types ? ': '~method.response.types|join('|') }}
+```
+
+{{ method.description|raw }}
+
+{% if method.static %}* This method is **static**.{% endif %}
+{% if method.deprecated %}* **Warning:** this method is **deprecated**. This means that this method will likely be removed in a future version.
+{% endif %}
+
+{% if method.arguments is not empty %}
+**Parameters:**
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+{% for argument in method.arguments %}
+| `{{ argument.name }}` | **{{ argument.types ? argument.types|join('|')|raw }}** | {{ argument.description|replace({'|': '|'})|raw }} |
+{% endfor %}
+
+{% endif %}{# method.arguments is not empty #}
+
+{% if method.response.description %}
+**Return Value:**
+
+{{ method.response.description|raw }}
+
+{% endif %}
+
+{% if method.tags.see is not empty or method.tags.link is not empty %}
+**See Also:**
+
+{% for see in method.tags.see %}
+* {{ see.reference }} {% if see.description %}- {{ see.description|raw }}{% endif %}
+{% endfor %}
+{% for link in method.tags.link %}
+* {{ link.link }} {% if link.description and link.description != link.link %}- {{ link.description|raw }}{% endif %}
+{% endfor %}
+
+{% endif %}{# method.tags.see || method.tags.link #}
+
+---
+
+{% endif %}{# method.visibility == 'public' #}
+{% endfor %}{# method in class.methods #}

data/templates/markdown-public/index.md.twig

@@ -0,0 +1,13 @@
+# {{ project.name|raw }}
+
+{# TODO ToC #}
+
+{% for class in project.indexes.classes|sort_asc %}
+{% if not class.abstract %}
+{% include 'class.md.twig' %}
+{% endif %}
+{% endfor %}
+
+
+--------
+> This document was automatically generated from source code comments on {{ "now"|date("Y-m-d") }} using [phpDocumentor](http://www.phpdoc.org/) and [cvuorinen/phpdoc-markdown-public](https://github.com/cvuorinen/phpdoc-markdown-public)

data/templates/markdown-public/template.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<template>
+  <author>Carl Vuorinen</author>
+  <email>carl.vuorinen@gmail.com</email>
+  <version>1.0.0</version>
+  <copyright>Carl Vuorinen 2015</copyright>
+  <description>Generate usage documentation (documents only it's public API) for a small library in Markdown format so it can be published in GitHub.</description>
+  <transformations>
+    <transformation writer="twig" source="templates/markdown-public/index.md.twig" artifact="README.md" />
+  </transformations>
+  <parameters>
+    <parameter key="twig-debug">true</parameter>
+  </parameters>
+</template>