virtualx-engine/doc/classes/PHashTranslation.xml
Rémi Verschelde f5836b40d4
doc: Use self-closing tags for return and argument
For the time being we don't support writing a description for those, preferring
having all details in the method's description.

Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.

(cherry picked from commit 7adf4cc9b5)
2021-08-03 10:20:19 +02:00

22 lines
645 B
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="PHashTranslation" inherits="Translation" version="3.4">
<brief_description>
Optimized translation.
</brief_description>
<description>
Optimized translation. Uses real-time compressed translations, which results in very small dictionaries.
</description>
<tutorials>
</tutorials>
<methods>
<method name="generate">
<return type="void" />
<argument index="0" name="from" type="Translation" />
<description>
Generates and sets an optimized translation from the given [Translation] resource.
</description>
</method>
</methods>
<constants>
</constants>
</class>