From fb5b607c13f9075bb13888f86b7e3344fc90dd18 Mon Sep 17 00:00:00 2001
From: Peter Hutterer <peter.hutterer@who-t.net>
Date: Tue, 7 Mar 2023 19:29:08 +1000
Subject: [PATCH] doc/proto: put a standard blurb in for the destructor-type
 requests

Should eventually have a separate protocol documentation section for
this and point to it, but this will do for now.
---
 doc/protocol/interface.md.tmpl | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/doc/protocol/interface.md.tmpl b/doc/protocol/interface.md.tmpl
index 1f13d01..8ce3c39 100644
--- a/doc/protocol/interface.md.tmpl
+++ b/doc/protocol/interface.md.tmpl
@@ -59,6 +59,17 @@ Enum names are shown here in uppercase. The exact name depends on the language b
 {% endfor %}
 {% endif %}
 
+{% if request.is_destructor %}
+{% raw %}
+{{% notice default "Destructor" "skull-crossbones" %}}
+{% endraw %}
+Immediately after sending this request, the object is considered destroyed
+by the EIS implementation. It must no longer be used by the client.
+{% raw %}
+{{% /notice %}}
+{% endraw %}
+{% endif %}
+
 {{request.description.text|ei_escape_names}}
 
 {% endfor %}
@@ -84,11 +95,22 @@ Enum names are shown here in uppercase. The exact name depends on the language b
 {% endfor %}
 {% endif %}
 
+{% if event.is_destructor %}
+{% raw %}
+{{% notice default "Destructor" "skull-crossbones" %}}
+{% endraw %}
+Immediately after sending this request, the object is considered destroyed
+by the EIS implementation. It must no longer be used by the client.
+{% raw %}
+{{% /notice %}}
+{% endraw %}
+{% endif %}
+
 {{event.description.text|ei_escape_names}}
 
+
 {% endfor %}
 {% endif %}
 
-
 {% endif %}
 {% endfor %}