hedgewars/uVideoRec.pas
changeset 13226 4028d7f85233
parent 12621 d972b31f8881
child 13496 c7df0d96da81
--- a/hedgewars/uVideoRec.pas	Thu Mar 15 21:28:10 2018 +0100
+++ b/hedgewars/uVideoRec.pas	Fri Mar 16 02:02:27 2018 +0100
@@ -93,7 +93,14 @@
     end;
 {$IOCHECKS ON}
 
-    // store some description in output file
+    { Store some description in output file.
+    The comment must follow a particular format and must be in English.
+    This will be parsed by the frontend.
+    The frontend will parse lines of this format:
+        Key: Value
+    The key names will be localized in the frontend.
+    If you add a key/value pair, don't forget to add a localization
+    in the frontend! }
     desc:= '';
     if UserNick <> '' then
         desc:= desc + 'Player: ' + UserNick + #10;