Sha256: c1d40b54b156283cd2af8398a6a860a7d57c201470edd8efba7703505f4c3a3c
Contents?: true
Size: 855 Bytes
Versions: 8
Compression:
Stored size: 855 Bytes
Contents
{%- comment -%}
////
Generates a reference table for documenting an API object.
////
{%- endcomment %}
{% assign obj = include.obj[1] %}
{% assign name_inferred = include.obj[0] | replace:"-"," " | capitalize %}
[cols="1,3",role="api-ref"]
|===
2+| [.big]*{{ obj['$doc']['name'] | default: name_inferred }}*{% if obj['$doc'] %}{% if obj['$doc']['desc'] %} +
{{ obj['$doc']['desc'] }}
{% endif %}
{% if obj['$doc']['tips'] %}
s|TIPS:
a|
{% for tip in obj['$doc']['tips'] %}
* {{ tip }}
{% endfor %}
{% endif %}
{% endif %}
{% for prop in obj %}
{% unless prop[0] == "$doc" %}
{% assign prop_name = prop[0] %}
s| block: `{{ prop_name }}`
{% if prop[1] %}
a|
{% assign prop_obj = prop[1] %}
{% include theme-api-object-sub.asciidoc sub=prop_obj %}
{% else %}
m| {{ prop[1] }}
{% endif %}
{% endunless %}
{% endfor %}
|===
Version data entries
8 entries across 8 versions & 2 rubygems