macros.html 1.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. {% macro typeList(types) -%}
  2. {% for typeName in types %}<a href="" class="{$ typeName | typeClass $}">{$ typeName | escape $}</a>{% endfor %}
  3. {%- endmacro -%}
  4. {%- macro paramTable(params) %}
  5. <table class="table">
  6. <thead>
  7. <tr>
  8. <th>Param</th>
  9. <th>Type</th>
  10. <th>Details</th>
  11. </tr>
  12. </thead>
  13. <tbody>
  14. {% for param in params %}
  15. <tr>
  16. <td>
  17. {$ param.name $}
  18. {% if param.alias %}| {$ param.alias $}{% endif %}
  19. {% if param.optional %}<div><em>(optional)</em></div>{% endif %}
  20. </td>
  21. <td>
  22. {$ typeList(param.typeList) $}
  23. </td>
  24. <td>
  25. {$ param.description | marked $}
  26. {% if param.defaultValue %}<p><em>(default: {$ param.defaultValue $})</em></p>{% endif %}
  27. </td>
  28. </tr>
  29. {% endfor %}
  30. </tbody>
  31. </table>
  32. {% endmacro -%}
  33. {%- macro directiveParam(name, type, join, sep) %}
  34. {%- if type.optional %}[{% endif -%}
  35. {$ name | dashCase $}{$ join $}{$ type.description $}{$ sep $}
  36. {%- if type.optional %}]{% endif -%}
  37. {% endmacro -%}
  38. {%- macro functionSyntax(fn) %}
  39. {%- set sep = joiner(', ') -%}
  40. {% marked -%}
  41. `{$ fn.name $}({%- for param in fn.params %}{$ sep() $}
  42. {%- if param.type.optional %}[{% endif -%}
  43. {$ param.name $}
  44. {%- if param.type.optional %}]{% endif -%}
  45. {% endfor %});`
  46. {%- endmarked %}
  47. {% endmacro -%}
  48. {%- macro typeInfo(fn) -%}
  49. <table class="variables-matrix return-arguments">
  50. <tr>
  51. <td>{$ typeList(fn.typeList) $}</td>
  52. <td>{$ fn.description | marked $}</td>
  53. </tr>
  54. </table>
  55. {%- endmacro -%}