[gi-docgen/ebassi/argument-annotation: 1/8] template: Update the method arguments table
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gi-docgen/ebassi/argument-annotation: 1/8] template: Update the method arguments table
- Date: Fri, 21 May 2021 14:11:14 +0000 (UTC)
commit f6c1f1ee8d294181bb50a54bbdadd070ef8837a8
Author: Emmanuele Bassi <ebassi gnome org>
Date: Mon May 17 14:07:04 2021 +0100
template: Update the method arguments table
Tweak the text for the generated rows.
gidocgen/templates/basic/method.html | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
---
diff --git a/gidocgen/templates/basic/method.html b/gidocgen/templates/basic/method.html
index 13828ce..6bb609c 100644
--- a/gidocgen/templates/basic/method.html
+++ b/gidocgen/templates/basic/method.html
@@ -115,18 +115,18 @@ SPDX-License-Identifier: Apache-2.0 OR GPL-3.0-or-later
{%- endif -%}
</td>
</tr>
+ {% if arg.direction != "in" %}<tr><td> </td><td>Direction: {{ arg.direction }}</td>.</tr>{%
endif %}
+ {% if arg.direction == "in" and arg.is_pointer and arg.nullable %}<tr><td> </td><td>Can be
<code>NULL</code></td>.</tr>{% endif %}
+ {% if arg.direction == "out" and arg.optional %}<tr><td> </td><td>Can be
<code>NULL</code></td>.</tr>{% endif %}
+ {% if arg.is_array and arg.zero_terminated %}<tr><td> </td><td>The array must be
<code>NULL</code> terminated</td>.</tr>{% endif %}
+ {% if arg.is_array and arg.fixed_size > 0 %}<tr><td> </td><td>The array must have {{
arg.fixed_size }} elements</td>.</tr>{% endif %}
+ {% if arg.is_array and arg.len_arg %}<tr><td> </td><td>The length of the array is in the
<code>{{ arg.len_arg }}</code> argument</td>.</tr>{% endif %}
+ {% if arg.is_pointer %}<tr><td> </td><td title="transfer: {{ arg.transfer }}">{{
arg.transfer_note }}</td></tr>{% endif %}
+ {% if arg.string_note %}<tr><td> </td><td>{{ arg.string_note }}</td></tr>{% endif %}
<tr class="arg-description">
<td> </td>
<td>{{ arg.description|safe }}</td>
</tr>
- {% if arg.direction != "in" %}<tr><td> </td><td>Direction: {{ arg.direction }}</td></tr>{%
endif %}
- {% if arg.direction == "in" and arg.is_pointer and arg.nullable %}<tr><td> </td><td>Can be
<code>NULL</code></td></tr>{% endif %}
- {% if arg.direction == "out" and arg.optional %}<tr><td> </td><td>Can be
<code>NULL</code></td></tr>{% endif %}
- {% if arg.is_array and arg.zero_terminated %}<tr><td> </td><td>The array must be
<code>NULL</code> terminated</td></tr>{% endif %}
- {% if arg.is_array and arg.fixed_size > 0 %}<tr><td> </td><td>The array must have {{
arg.fixed_size }} elements</td></tr>{% endif %}
- {% if arg.is_array and arg.len_arg %}<tr><td> </td><td>The length of the array is in the
<code>{{ arg.len_arg }}</code> argument</td></tr>{% endif %}
- {% if arg.is_pointer %}<tr><td> </td><td title="transfer: {{ arg.transfer }}">{{
arg.transfer_note }}</td></tr>{% endif %}
- {% if arg.string_note %}<tr><td> </td><td>{{ arg.string_note }}</td></tr>{% endif %}
{% endfor %}
</table>
</div>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]