asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
virtualx-engine/doc/classes/FileSystemDock.xml

81 lines
2.3 KiB
XML
Raw Normal View History

Sync classref with current source
2020-03-25 11:42:15 +01:00
<?xml version="1.0" encoding="UTF-8" ?>
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 23:01:02 +01:00
<class name="FileSystemDock" inherits="VBoxContainer" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Sync classref with current source
2020-03-25 11:42:15 +01:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="can_drop_data_fw" qualifiers="const">
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 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="bool" />
Fix missing argument names in FileSystemDock bindings
2021-10-09 00:31:14 +02:00
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="data" type="Variant" />
<argument index="2" name="from" type="Control" />
Sync classref with current source
2020-03-25 11:42:15 +01:00
<description>
</description>
</method>
<method name="drop_data_fw">
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 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
Fix missing argument names in FileSystemDock bindings
2021-10-09 00:31:14 +02:00
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="data" type="Variant" />
<argument index="2" name="from" type="Control" />
Sync classref with current source
2020-03-25 11:42:15 +01:00
<description>
</description>
</method>
<method name="get_drag_data_fw">
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 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="Variant" />
Fix missing argument names in FileSystemDock bindings
2021-10-09 00:31:14 +02:00
<argument index="0" name="point" type="Vector2" />
<argument index="1" name="from" type="Control" />
Sync classref with current source
2020-03-25 11:42:15 +01:00
<description>
</description>
</method>
<method name="navigate_to_path">
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 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<return type="void" />
Fix missing argument names in FileSystemDock bindings
2021-10-09 00:31:14 +02:00
<argument index="0" name="path" type="String" />
Sync classref with current source
2020-03-25 11:42:15 +01:00
<description>
</description>
</method>
</methods>
<signals>
<signal name="display_mode_changed">
<description>
</description>
</signal>
<signal name="file_removed">
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 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<argument index="0" name="file" type="String" />
Sync classref with current source
2020-03-25 11:42:15 +01:00
<description>
</description>
</signal>
<signal name="files_moved">
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 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<argument index="0" name="old_file" type="String" />
<argument index="1" name="new_file" type="String" />
Sync classref with current source
2020-03-25 11:42:15 +01:00
<description>
</description>
</signal>
<signal name="folder_moved">
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 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<argument index="0" name="old_folder" type="String" />
<argument index="1" name="new_file" type="String" />
Sync classref with current source
2020-03-25 11:42:15 +01:00
<description>
</description>
</signal>
<signal name="folder_removed">
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 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<argument index="0" name="folder" type="String" />
Sync classref with current source
2020-03-25 11:42:15 +01:00
<description>
</description>
</signal>
<signal name="inherit">
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 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<argument index="0" name="file" type="String" />
Sync classref with current source
2020-03-25 11:42:15 +01:00
<description>
</description>
</signal>
<signal name="instance">
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 7adf4cc9b5de6701a41e27690a69b9892d5eed85)
2021-07-30 15:28:05 +02:00
<argument index="0" name="files" type="PoolStringArray" />
Sync classref with current source
2020-03-25 11:42:15 +01:00
<description>
</description>
</signal>
</signals>
<constants>
</constants>
</class>
Reference in a new issue Copy permalink