Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 07:31:16 +00:00
Code Issues Projects Releases Packages Wiki Activity
godot/doc/classes/PolygonPathFinder.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

63 lines
1.8 KiB
XML
Raw Normal View History

Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<?xml version="1.0" encoding="UTF-8" ?>
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:05 +02:00
<class name="PolygonPathFinder" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="find_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.
2021-07-30 15:28:05 +02:00
<return type="PackedVector2Array" />
Rename the argument tag to param in XML documentation
2022-08-06 21:11:48 +03:00
<param index="0" name="from" type="Vector2" />
<param index="1" name="to" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<description>
</description>
</method>
<method name="get_bounds" 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.
2021-07-30 15:28:05 +02:00
<return type="Rect2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<description>
</description>
</method>
<method name="get_closest_point" 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.
2021-07-30 15:28:05 +02:00
<return type="Vector2" />
Rename the argument tag to param in XML documentation
2022-08-06 21:11:48 +03:00
<param index="0" name="point" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<description>
</description>
</method>
<method name="get_intersections" 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.
2021-07-30 15:28:05 +02:00
<return type="PackedVector2Array" />
Rename the argument tag to param in XML documentation
2022-08-06 21:11:48 +03:00
<param index="0" name="from" type="Vector2" />
<param index="1" name="to" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<description>
</description>
</method>
<method name="get_point_penalty" 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.
2021-07-30 15:28:05 +02:00
<return type="float" />
Rename the argument tag to param in XML documentation
2022-08-06 21:11:48 +03:00
<param index="0" name="idx" type="int" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<description>
</description>
</method>
<method name="is_point_inside" 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.
2021-07-30 15:28:05 +02:00
<return type="bool" />
Rename the argument tag to param in XML documentation
2022-08-06 21:11:48 +03:00
<param index="0" name="point" type="Vector2" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<description>
</description>
</method>
<method name="set_point_penalty">
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.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 21:11:48 +03:00
<param index="0" name="idx" type="int" />
<param index="1" name="penalty" type="float" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<description>
</description>
</method>
<method name="setup">
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.
2021-07-30 15:28:05 +02:00
<return type="void" />
Rename the argument tag to param in XML documentation
2022-08-06 21:11:48 +03:00
<param index="0" name="points" type="PackedVector2Array" />
<param index="1" name="connections" type="PackedInt32Array" />
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them.
2017-09-12 17:42:36 -03:00
<description>
</description>
</method>
</methods>
</class>
Reference in a new issue Copy permalink