This is mainly to not lose what I have so far. The idea is to run phpdocumentor on a select number of source code files, with the goal of rendering something like https://www.adminer.org/en/extension/ The output should be in Markdown, ideally injected into a file in the docs/ folder, and auto-deployed to the docs website.
32 lines
1 KiB
Twig
32 lines
1 KiB
Twig
## {{ 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 #}
|
|
|
|
{% for method in class.methods %}
|
|
{% if method.visibility == 'public' %}
|
|
{% include 'method.md.twig' %}
|
|
{% endif %}
|
|
{% endfor %}
|