doc/message-registry.md.jinja

   1 # Error index { {#--#} #error-index}
   2
   3 {# NOTE: Prevent Doxygen issue by writing the comment after the first header. #}
   4 <!--
   5 NOTE: This file has been generated automatically by “{{script}}”.
   6       Do not edit manually!
   7 -->
   8
   9 This page lists the warnings and errors generated by xkbcommon.
  10 There are currently {{ entries|length }} entries.
  11
  12 @todo The documentation of the log messages is a work in progress.
  13
  14 ## Index
  15
  16 | Code      | Identifier                   | Description | Type |
  17 | --------- | ---------------------------- | ----------- | ---- |
  18 {% for entry in entries %}
  19 | [{{entry.message_code}}] | `{{entry.id}}` | {{entry.description|prepend_todo}} | {{entry.type|capitalize}} |
  20 {% endfor %}
  21
  22 ## Details
  23
  24 {% for entry in entries %}
  25 ### {{entry.message_code}} – {{entry.message_name}} { {#--#}#{{entry.message_code}}}
  26
  27 <dl>
  28 {% if entry.removed %}
  29   <dt>Added in</dt><dd>{{entry.added}}</dd>
  30   <dt>Removed in</dt><dd>{{entry.removed}}</dd>
  31 {% else %}
  32   <dt>Since</dt><dd>{{entry.added}}</dd>
  33 {% endif %}
  34   <dt>Type</dt><dd>{{entry.type|capitalize}}</dd>
  35   <dt>Summary</dt><dd>{{entry.description|prepend_todo}}</dd>
  36 </dl>
  37
  38 {% if entry.details %}
  39 {{entry.details}}
  40
  41 {% endif %}
  42 {% if entry.examples %}
  43 #### Examples
  44
  45 {% for example in entry.examples %}
  46 <details>
  47   <summary>{{example.name}}</summary>
  48
  49 {{example.description}}
  50 {% if example.before %}
  51 **Fix:**
  52   <div class="example-container">
  53     <div class="example">
  54       <div class="example-inner">
  55         <div class="example-title">Before</div>
  56 {{example.before-}}
  57       </div>
  58     </div>
  59     <div class="example">
  60       <div class="example-inner">
  61         <div class="example-title">After</div>
  62 {{example.after-}}
  63       </div>
  64     </div>
  65   </div>
  66 {% endif %}
  67 </details>
  68
  69 {% endfor %}
  70 {% endif %}
  71 {% endfor %}
  72 {% for entry in entries %}
  73 [{{entry.message_code}}]: @ref {{entry.message_code}}
  74 {% endfor %}