Skip to content

Add in-editor documentation support #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Spartan322 merged 1 commit into from
Nov 27, 2024
Merged

Add in-editor documentation support #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,3 +84,6 @@ compile_commands.json

# ccls
.ccls-cache

# Generated source files
extension/src/gen/*
4 changes: 4 additions & 0 deletions SConstruct
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,10 @@ env.Append(CPPPATH=[[env.Dir(p) for p in paths]])
sources = env.GlobRecursive("*.cpp", paths)
env.extension_sources = sources

if env["target"] in ["editor", "template_debug"]:
doc_data = godot_env.GodotCPPDocData("extension/src/gen/doc_data.gen.cpp", source=Glob("extension/doc_classes/*.xml"))
sources.append(doc_data)

# Remove unassociated intermediate binary files if allowed, usually the result of a renamed or deleted source file
if env["intermediate_delete"]:
from glob import glob
Expand Down
41 changes: 41 additions & 0 deletions extension/doc_classes/AssetManager.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_font">
<return type="FontFile" />
<param index="0" name="name" type="StringName" />
<description>
</description>
</method>
<method name="get_image">
<return type="Image" />
<param index="0" name="path" type="StringName" />
<param index="1" name="load_flags" type="int" enum="AssetManager.LoadFlags" default="1" />
<description>
</description>
</method>
<method name="get_texture">
<return type="ImageTexture" />
<param index="0" name="path" type="StringName" />
<param index="1" name="load_flags" type="int" enum="AssetManager.LoadFlags" default="2" />
<description>
</description>
</method>
</methods>
<constants>
<constant name="LOAD_FLAG_NONE" value="0" enum="LoadFlags">
</constant>
<constant name="LOAD_FLAG_CACHE_IMAGE" value="1" enum="LoadFlags">
</constant>
<constant name="LOAD_FLAG_CACHE_TEXTURE" value="2" enum="LoadFlags">
</constant>
<constant name="LOAD_FLAG_FLIP_Y" value="4" enum="LoadFlags">
</constant>
</constants>
</class>
16 changes: 16 additions & 0 deletions extension/doc_classes/Checksum.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_checksum_text">
<return type="String" />
<description>
</description>
</method>
</methods>
</class>
17 changes: 17 additions & 0 deletions extension/doc_classes/GFXButtonStateHavingTexture.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_button_state_texture">
<return type="GFXButtonStateTexture" />
<param index="0" name="button_state" type="int" enum="GFXButtonStateTexture.ButtonState" />
<description>
</description>
</method>
</methods>
</class>
51 changes: 51 additions & 0 deletions extension/doc_classes/GFXButtonStateTexture.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="button_state_to_name" qualifiers="static">
<return type="StringName" />
<param index="0" name="button_state" type="int" enum="GFXButtonStateTexture.ButtonState" />
<description>
</description>
</method>
<method name="generate_state_image">
<return type="int" enum="Error" />
<param index="0" name="source_image" type="Image" />
<param index="1" name="_unnamed_arg1" type="Rect2i" />
<param index="2" name="_unnamed_arg2" type="Vector2i" />
<description>
</description>
</method>
<method name="get_button_state" qualifiers="const">
<return type="int" enum="GFXButtonStateTexture.ButtonState" />
<description>
</description>
</method>
<method name="get_button_state_name" qualifiers="const">
<return type="StringName" />
<description>
</description>
</method>
<method name="set_button_state">
<return type="void" />
<param index="0" name="new_button_state" type="int" enum="GFXButtonStateTexture.ButtonState" />
<description>
</description>
</method>
</methods>
<constants>
<constant name="HOVER" value="0" enum="ButtonState">
</constant>
<constant name="PRESSED" value="1" enum="ButtonState">
</constant>
<constant name="DISABLED" value="2" enum="ButtonState">
</constant>
<constant name="SELECTED" value="3" enum="ButtonState">
</constant>
</constants>
</class>
28 changes: 28 additions & 0 deletions extension/doc_classes/GFXCorneredTileSupportingTexture.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="draw_rect_cornered" qualifiers="const">
<return type="void" />
<param index="0" name="to_canvas_item" type="RID" />
<param index="1" name="rect" type="Rect2" />
<description>
</description>
</method>
<method name="get_cornered_tile_border_size" qualifiers="const">
<return type="Vector2i" />
<description>
</description>
</method>
<method name="is_cornered_tile_texture" qualifiers="const">
<return type="bool" />
<description>
</description>
</method>
</methods>
</class>
50 changes: 50 additions & 0 deletions extension/doc_classes/GFXMaskedFlagTexture.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="clear">
<return type="void" />
<description>
</description>
</method>
<method name="get_flag_country_name" qualifiers="const">
<return type="String" />
<description>
</description>
</method>
<method name="get_flag_type" qualifiers="const">
<return type="StringName" />
<description>
</description>
</method>
<method name="get_gfx_masked_flag_name" qualifiers="const">
<return type="String" />
<description>
</description>
</method>
<method name="set_flag_country_name">
<return type="int" enum="Error" />
<param index="0" name="new_flag_country_name" type="String" />
<description>
</description>
</method>
<method name="set_flag_country_name_and_type">
<return type="int" enum="Error" />
<param index="0" name="new_flag_country_name" type="String" />
<param index="1" name="new_flag_type" type="StringName" />
<description>
</description>
</method>
<method name="set_gfx_masked_flag_name">
<return type="int" enum="Error" />
<param index="0" name="gfx_masked_flag_name" type="String" />
<description>
</description>
</method>
</methods>
</class>
33 changes: 33 additions & 0 deletions extension/doc_classes/GFXPieChartTexture.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="clear">
<return type="void" />
<description>
</description>
</method>
<method name="get_gfx_pie_chart_name" qualifiers="const">
<return type="String" />
<description>
</description>
</method>
<method name="set_gfx_pie_chart_name">
<return type="int" enum="Error" />
<param index="0" name="gfx_pie_chart_name" type="String" />
<description>
</description>
</method>
<method name="set_slices_array">
<return type="int" enum="Error" />
<param index="0" name="new_slices" type="Dictionary[]" />
<description>
</description>
</method>
</methods>
</class>
49 changes: 49 additions & 0 deletions extension/doc_classes/GFXSpriteTexture.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="clear">
<return type="void" />
<description>
</description>
</method>
<method name="get_gfx_texture_sprite_name" qualifiers="const">
<return type="String" />
<description>
</description>
</method>
<method name="get_icon_count" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="set_gfx_texture_sprite_name">
<return type="int" enum="Error" />
<param index="0" name="gfx_texture_sprite_name" type="String" />
<param index="1" name="icon" type="int" default="0" />
<description>
</description>
</method>
<method name="set_icon_index">
<return type="int" enum="Error" />
<param index="0" name="new_icon_index" type="int" />
<description>
</description>
</method>
<method name="set_toggled_icon">
<return type="int" enum="Error" />
<param index="0" name="toggle" type="bool" />
<description>
</description>
</method>
</methods>
<members>
<member name="icon_index" type="int" setter="set_icon_index" getter="get_icon_index" default="0">
</member>
</members>
</class>
31 changes: 31 additions & 0 deletions extension/doc_classes/GUIButton.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="clear_tooltip">
<return type="void" />
<description>
</description>
</method>
<method name="set_tooltip_string_and_substitution_dict">
<return type="void" />
<param index="0" name="new_tooltip_string" type="String" />
<param index="1" name="new_tooltip_substitution_dict" type="Dictionary" />
<description>
</description>
</method>
</methods>
<members>
<member name="tooltip_active" type="bool" setter="" getter="is_tooltip_active" default="false">
</member>
<member name="tooltip_string" type="String" setter="set_tooltip_string" getter="get_tooltip_string" default="&quot;&quot;">
</member>
<member name="tooltip_substitution_dict" type="Dictionary" setter="set_tooltip_substitution_dict" getter="get_tooltip_substitution_dict" default="{}">
</member>
</members>
</class>
45 changes: 45 additions & 0 deletions extension/doc_classes/GUIIcon.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8" ?>
<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">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="get_gfx_sprite_texture" qualifiers="const">
<return type="GFXSpriteTexture" />
<description>
</description>
</method>
<method name="get_gfx_texture_sprite_name" qualifiers="const">
<return type="String" />
<description>
</description>
</method>
<method name="get_icon_index" qualifiers="const">
<return type="int" />
<description>
</description>
</method>
<method name="set_gfx_texture_sprite_name">
<return type="int" enum="Error" />
<param index="0" name="gfx_texture_sprite_name" type="String" />
<param index="1" name="icon" type="int" default="0" />
<description>
</description>
</method>
<method name="set_icon_index" qualifiers="const">
<return type="int" enum="Error" />
<param index="0" name="icon_index" type="int" />
<description>
</description>
</method>
<method name="set_toggled_icon" qualifiers="const">
<return type="int" enum="Error" />
<param index="0" name="toggled" type="bool" />
<description>
</description>
</method>
</methods>
</class>
Loading
Loading