Skip to content

Commit 217b9bf

Browse files
Spartan322Spartan322
committed
Add in-editor documentation support
1 parent 374ce48 commit 217b9bf

29 files changed

+1964
-0
lines changed

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,6 @@ compile_commands.json
8484

8585
# ccls
8686
.ccls-cache
87+
88+
# Generated source files
89+
extension/src/gen/*

‎SConstruct

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,10 @@ env.Append(CPPPATH=[[env.Dir(p) for p in paths]])
4545
sources = env.GlobRecursive("*.cpp", paths)
4646
env.extension_sources = sources
4747

48+
if env["target"] in ["editor", "template_debug"]:
49+
doc_data = godot_env.GodotCPPDocData("extension/src/gen/doc_data.gen.cpp", source=Glob("extension/doc_classes/*.xml"))
50+
sources.append(doc_data)
51+
4852
# Remove unassociated intermediate binary files if allowed, usually the result of a renamed or deleted source file
4953
if env["intermediate_delete"]:
5054
from glob import glob

‎extension/doc_classes/AssetManager.xml

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<class name="AssetManager" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
3+
<brief_description>
4+
</brief_description>
5+
<description>
6+
</description>
7+
<tutorials>
8+
</tutorials>
9+
<methods>
10+
<method name="get_font">
11+
<return type="FontFile" />
12+
<param index="0" name="name" type="StringName" />
13+
<description>
14+
</description>
15+
</method>
16+
<method name="get_image">
17+
<return type="Image" />
18+
<param index="0" name="path" type="StringName" />
19+
<param index="1" name="load_flags" type="int" enum="AssetManager.LoadFlags" default="1" />
20+
<description>
21+
</description>
22+
</method>
23+
<method name="get_texture">
24+
<return type="ImageTexture" />
25+
<param index="0" name="path" type="StringName" />
26+
<param index="1" name="load_flags" type="int" enum="AssetManager.LoadFlags" default="2" />
27+
<description>
28+
</description>
29+
</method>
30+
</methods>
31+
<constants>
32+
<constant name="LOAD_FLAG_NONE" value="0" enum="LoadFlags">
33+
</constant>
34+
<constant name="LOAD_FLAG_CACHE_IMAGE" value="1" enum="LoadFlags">
35+
</constant>
36+
<constant name="LOAD_FLAG_CACHE_TEXTURE" value="2" enum="LoadFlags">
37+
</constant>
38+
<constant name="LOAD_FLAG_FLIP_Y" value="4" enum="LoadFlags">
39+
</constant>
40+
</constants>
41+
</class>

‎extension/doc_classes/Checksum.xml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<class name="Checksum" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
3+
<brief_description>
4+
</brief_description>
5+
<description>
6+
</description>
7+
<tutorials>
8+
</tutorials>
9+
<methods>
10+
<method name="get_checksum_text">
11+
<return type="String" />
12+
<description>
13+
</description>
14+
</method>
15+
</methods>
16+
</class>

‎extension/doc_classes/GFXButtonStateHavingTexture.xml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<class name="GFXButtonStateHavingTexture" inherits="GFXCorneredTileSupportingTexture" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
3+
<brief_description>
4+
</brief_description>
5+
<description>
6+
</description>
7+
<tutorials>
8+
</tutorials>
9+
<methods>
10+
<method name="get_button_state_texture">
11+
<return type="GFXButtonStateTexture" />
12+
<param index="0" name="button_state" type="int" enum="GFXButtonStateTexture.ButtonState" />
13+
<description>
14+
</description>
15+
</method>
16+
</methods>
17+
</class>

‎extension/doc_classes/GFXButtonStateTexture.xml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<class name="GFXButtonStateTexture" inherits="GFXCorneredTileSupportingTexture" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
3+
<brief_description>
4+
</brief_description>
5+
<description>
6+
</description>
7+
<tutorials>
8+
</tutorials>
9+
<methods>
10+
<method name="button_state_to_name" qualifiers="static">
11+
<return type="StringName" />
12+
<param index="0" name="button_state" type="int" enum="GFXButtonStateTexture.ButtonState" />
13+
<description>
14+
</description>
15+
</method>
16+
<method name="generate_state_image">
17+
<return type="int" enum="Error" />
18+
<param index="0" name="source_image" type="Image" />
19+
<param index="1" name="_unnamed_arg1" type="Rect2i" />
20+
<param index="2" name="_unnamed_arg2" type="Vector2i" />
21+
<description>
22+
</description>
23+
</method>
24+
<method name="get_button_state" qualifiers="const">
25+
<return type="int" enum="GFXButtonStateTexture.ButtonState" />
26+
<description>
27+
</description>
28+
</method>
29+
<method name="get_button_state_name" qualifiers="const">
30+
<return type="StringName" />
31+
<description>
32+
</description>
33+
</method>
34+
<method name="set_button_state">
35+
<return type="void" />
36+
<param index="0" name="new_button_state" type="int" enum="GFXButtonStateTexture.ButtonState" />
37+
<description>
38+
</description>
39+
</method>
40+
</methods>
41+
<constants>
42+
<constant name="HOVER" value="0" enum="ButtonState">
43+
</constant>
44+
<constant name="PRESSED" value="1" enum="ButtonState">
45+
</constant>
46+
<constant name="DISABLED" value="2" enum="ButtonState">
47+
</constant>
48+
<constant name="SELECTED" value="3" enum="ButtonState">
49+
</constant>
50+
</constants>
51+
</class>

‎extension/doc_classes/GFXCorneredTileSupportingTexture.xml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<class name="GFXCorneredTileSupportingTexture" inherits="AtlasTexture" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
3+
<brief_description>
4+
</brief_description>
5+
<description>
6+
</description>
7+
<tutorials>
8+
</tutorials>
9+
<methods>
10+
<method name="draw_rect_cornered" qualifiers="const">
11+
<return type="void" />
12+
<param index="0" name="to_canvas_item" type="RID" />
13+
<param index="1" name="rect" type="Rect2" />
14+
<description>
15+
</description>
16+
</method>
17+
<method name="get_cornered_tile_border_size" qualifiers="const">
18+
<return type="Vector2i" />
19+
<description>
20+
</description>
21+
</method>
22+
<method name="is_cornered_tile_texture" qualifiers="const">
23+
<return type="bool" />
24+
<description>
25+
</description>
26+
</method>
27+
</methods>
28+
</class>

‎extension/doc_classes/GFXMaskedFlagTexture.xml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<class name="GFXMaskedFlagTexture" inherits="GFXButtonStateHavingTexture" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
3+
<brief_description>
4+
</brief_description>
5+
<description>
6+
</description>
7+
<tutorials>
8+
</tutorials>
9+
<methods>
10+
<method name="clear">
11+
<return type="void" />
12+
<description>
13+
</description>
14+
</method>
15+
<method name="get_flag_country_name" qualifiers="const">
16+
<return type="String" />
17+
<description>
18+
</description>
19+
</method>
20+
<method name="get_flag_type" qualifiers="const">
21+
<return type="StringName" />
22+
<description>
23+
</description>
24+
</method>
25+
<method name="get_gfx_masked_flag_name" qualifiers="const">
26+
<return type="String" />
27+
<description>
28+
</description>
29+
</method>
30+
<method name="set_flag_country_name">
31+
<return type="int" enum="Error" />
32+
<param index="0" name="new_flag_country_name" type="String" />
33+
<description>
34+
</description>
35+
</method>
36+
<method name="set_flag_country_name_and_type">
37+
<return type="int" enum="Error" />
38+
<param index="0" name="new_flag_country_name" type="String" />
39+
<param index="1" name="new_flag_type" type="StringName" />
40+
<description>
41+
</description>
42+
</method>
43+
<method name="set_gfx_masked_flag_name">
44+
<return type="int" enum="Error" />
45+
<param index="0" name="gfx_masked_flag_name" type="String" />
46+
<description>
47+
</description>
48+
</method>
49+
</methods>
50+
</class>

‎extension/doc_classes/GFXPieChartTexture.xml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<class name="GFXPieChartTexture" inherits="ImageTexture" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
3+
<brief_description>
4+
</brief_description>
5+
<description>
6+
</description>
7+
<tutorials>
8+
</tutorials>
9+
<methods>
10+
<method name="clear">
11+
<return type="void" />
12+
<description>
13+
</description>
14+
</method>
15+
<method name="get_gfx_pie_chart_name" qualifiers="const">
16+
<return type="String" />
17+
<description>
18+
</description>
19+
</method>
20+
<method name="set_gfx_pie_chart_name">
21+
<return type="int" enum="Error" />
22+
<param index="0" name="gfx_pie_chart_name" type="String" />
23+
<description>
24+
</description>
25+
</method>
26+
<method name="set_slices_array">
27+
<return type="int" enum="Error" />
28+
<param index="0" name="new_slices" type="Dictionary[]" />
29+
<description>
30+
</description>
31+
</method>
32+
</methods>
33+
</class>

‎extension/doc_classes/GFXSpriteTexture.xml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<class name="GFXSpriteTexture" inherits="GFXButtonStateHavingTexture" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
3+
<brief_description>
4+
</brief_description>
5+
<description>
6+
</description>
7+
<tutorials>
8+
</tutorials>
9+
<methods>
10+
<method name="clear">
11+
<return type="void" />
12+
<description>
13+
</description>
14+
</method>
15+
<method name="get_gfx_texture_sprite_name" qualifiers="const">
16+
<return type="String" />
17+
<description>
18+
</description>
19+
</method>
20+
<method name="get_icon_count" qualifiers="const">
21+
<return type="int" />
22+
<description>
23+
</description>
24+
</method>
25+
<method name="set_gfx_texture_sprite_name">
26+
<return type="int" enum="Error" />
27+
<param index="0" name="gfx_texture_sprite_name" type="String" />
28+
<param index="1" name="icon" type="int" default="0" />
29+
<description>
30+
</description>
31+
</method>
32+
<method name="set_icon_index">
33+
<return type="int" enum="Error" />
34+
<param index="0" name="new_icon_index" type="int" />
35+
<description>
36+
</description>
37+
</method>
38+
<method name="set_toggled_icon">
39+
<return type="int" enum="Error" />
40+
<param index="0" name="toggle" type="bool" />
41+
<description>
42+
</description>
43+
</method>
44+
</methods>
45+
<members>
46+
<member name="icon_index" type="int" setter="set_icon_index" getter="get_icon_index" default="0">
47+
</member>
48+
</members>
49+
</class>

‎extension/doc_classes/GUIButton.xml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<class name="GUIButton" inherits="Button" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
3+
<brief_description>
4+
</brief_description>
5+
<description>
6+
</description>
7+
<tutorials>
8+
</tutorials>
9+
<methods>
10+
<method name="clear_tooltip">
11+
<return type="void" />
12+
<description>
13+
</description>
14+
</method>
15+
<method name="set_tooltip_string_and_substitution_dict">
16+
<return type="void" />
17+
<param index="0" name="new_tooltip_string" type="String" />
18+
<param index="1" name="new_tooltip_substitution_dict" type="Dictionary" />
19+
<description>
20+
</description>
21+
</method>
22+
</methods>
23+
<members>
24+
<member name="tooltip_active" type="bool" setter="" getter="is_tooltip_active" default="false">
25+
</member>
26+
<member name="tooltip_string" type="String" setter="set_tooltip_string" getter="get_tooltip_string" default="&quot;&quot;">
27+
</member>
28+
<member name="tooltip_substitution_dict" type="Dictionary" setter="set_tooltip_substitution_dict" getter="get_tooltip_substitution_dict" default="{}">
29+
</member>
30+
</members>
31+
</class>

‎extension/doc_classes/GUIIcon.xml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<?xml version="1.0" encoding="UTF-8" ?>
2+
<class name="GUIIcon" inherits="GUITextureRect" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/godotengine/godot/master/doc/class.xsd">
3+
<brief_description>
4+
</brief_description>
5+
<description>
6+
</description>
7+
<tutorials>
8+
</tutorials>
9+
<methods>
10+
<method name="get_gfx_sprite_texture" qualifiers="const">
11+
<return type="GFXSpriteTexture" />
12+
<description>
13+
</description>
14+
</method>
15+
<method name="get_gfx_texture_sprite_name" qualifiers="const">
16+
<return type="String" />
17+
<description>
18+
</description>
19+
</method>
20+
<method name="get_icon_index" qualifiers="const">
21+
<return type="int" />
22+
<description>
23+
</description>
24+
</method>
25+
<method name="set_gfx_texture_sprite_name">
26+
<return type="int" enum="Error" />
27+
<param index="0" name="gfx_texture_sprite_name" type="String" />
28+
<param index="1" name="icon" type="int" default="0" />
29+
<description>
30+
</description>
31+
</method>
32+
<method name="set_icon_index" qualifiers="const">
33+
<return type="int" enum="Error" />
34+
<param index="0" name="icon_index" type="int" />
35+
<description>
36+
</description>
37+
</method>
38+
<method name="set_toggled_icon" qualifiers="const">
39+
<return type="int" enum="Error" />
40+
<param index="0" name="toggled" type="bool" />
41+
<description>
42+
</description>
43+
</method>
44+
</methods>
45+
</class>

0 commit comments

Comments
 (0)