Skip to content

Commit

Permalink
Embed XML API documentation into the engine
Browse files Browse the repository at this point in the history
  • Loading branch information
@TokisanGames
TokisanGames committed Oct 5, 2024
1 parent d056e26 commit 6605c07
Show file tree
Hide file tree
Showing 31 changed files with 1,001 additions and 1,017 deletions.
5 changes: 5 additions & 0 deletions SConstruct
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,11 @@ if scons_cache_path != None:
CacheDir(scons_cache_path)
print("Scons cache enabled... (path: '" + scons_cache_path + "')")

# Embed documentation into the engine
if env["target"] in ["editor", "template_debug"]:
doc_data = env.GodotCPPDocData("src/gen/doc_data.gen.cpp", source=Glob("doc/doc_classes/*.xml"))
sources.append(doc_data)

# Create the library target (e.g. libexample.linux.debug.x86_64.so).
debug_or_release = "release" if env["target"] == "template_release" else "debug"
if env["platform"] == "macos":
Expand Down
26 changes: 13 additions & 13 deletions Terrain3D.vcxproj
View file
Original file line number Diff line number Diff line change
Expand Up @@ -238,19 +238,19 @@
<Text Include="src\shaders\gpu_depth.glsl" />
</ItemGroup>
<ItemGroup>
<Xml Include="doc\classes\Terrain3D.xml" />
<Xml Include="doc\classes\Terrain3DData.xml" />
<Xml Include="doc\classes\Terrain3DEditor.xml" />
<Xml Include="doc\classes\Terrain3DInstancer.xml" />
<Xml Include="doc\classes\Terrain3DMaterial.xml" />
<Xml Include="doc\classes\Terrain3DMeshAsset.xml" />
<Xml Include="doc\classes\Terrain3DRegion.xml" />
<Xml Include="doc\classes\Terrain3DStorage.xml" />
<Xml Include="doc\classes\Terrain3DTexture.xml" />
<Xml Include="doc\classes\Terrain3DTextureAsset.xml" />
<Xml Include="doc\classes\Terrain3DAssets.xml" />
<Xml Include="doc\classes\Terrain3DTextureList.xml" />
<Xml Include="doc\classes\Terrain3DUtil.xml" />
<Xml Include="doc\doc_classes\Terrain3D.xml" />
<Xml Include="doc\doc_classes\Terrain3DAssets.xml" />
<Xml Include="doc\doc_classes\Terrain3DData.xml" />
<Xml Include="doc\doc_classes\Terrain3DEditor.xml" />
<Xml Include="doc\doc_classes\Terrain3DInstancer.xml" />
<Xml Include="doc\doc_classes\Terrain3DMaterial.xml" />
<Xml Include="doc\doc_classes\Terrain3DMeshAsset.xml" />
<Xml Include="doc\doc_classes\Terrain3DRegion.xml" />
<Xml Include="doc\doc_classes\Terrain3DStorage.xml" />
<Xml Include="doc\doc_classes\Terrain3DTexture.xml" />
<Xml Include="doc\doc_classes\Terrain3DTextureAsset.xml" />
<Xml Include="doc\doc_classes\Terrain3DTextureList.xml" />
<Xml Include="doc\doc_classes\Terrain3DUtil.xml" />
</ItemGroup>
<Import Project="$(VCTargetsPath)\Microsoft.Cpp.targets" />
<ImportGroup Label="ExtensionTargets">
Expand Down
26 changes: 13 additions & 13 deletions Terrain3D.vcxproj.filters
View file
Original file line number Diff line number Diff line change
Expand Up @@ -305,43 +305,43 @@
</Text>
</ItemGroup>
<ItemGroup>
<Xml Include="doc\classes\Terrain3D.xml">
<Xml Include="doc\doc_classes\Terrain3D.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DEditor.xml">
<Xml Include="doc\doc_classes\Terrain3DAssets.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DMaterial.xml">
<Xml Include="doc\doc_classes\Terrain3DData.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DStorage.xml">
<Xml Include="doc\doc_classes\Terrain3DEditor.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DTextureAsset.xml">
<Xml Include="doc\doc_classes\Terrain3DInstancer.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DAssets.xml">
<Xml Include="doc\doc_classes\Terrain3DMaterial.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DUtil.xml">
<Xml Include="doc\doc_classes\Terrain3DMeshAsset.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DInstancer.xml">
<Xml Include="doc\doc_classes\Terrain3DRegion.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DTextureList.xml">
<Xml Include="doc\doc_classes\Terrain3DStorage.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DMeshAsset.xml">
<Xml Include="doc\doc_classes\Terrain3DTexture.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DTexture.xml">
<Xml Include="doc\doc_classes\Terrain3DTextureAsset.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DData.xml">
<Xml Include="doc\doc_classes\Terrain3DTextureList.xml">
<Filter>3. XML</Filter>
</Xml>
<Xml Include="doc\classes\Terrain3DRegion.xml">
<Xml Include="doc\doc_classes\Terrain3DUtil.xml">
<Filter>3. XML</Filter>
</Xml>
</ItemGroup>
Expand Down
298 changes: 149 additions & 149 deletions doc/api/class_terrain3d.rst
View file

Large diffs are not rendered by default.

90 changes: 45 additions & 45 deletions doc/api/class_terrain3dassets.rst
View file

Large diffs are not rendered by default.

452 changes: 226 additions & 226 deletions doc/api/class_terrain3ddata.rst
View file

Large diffs are not rendered by default.

68 changes: 34 additions & 34 deletions doc/api/class_terrain3deditor.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
.. DO NOT EDIT THIS FILE!!!
.. Generated automatically from Godot engine sources.
.. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py.
.. XML source: https://github.com/godotengine/godot/tree/4.3/../_plugins/Terrain3D/doc/classes/Terrain3DEditor.xml.
.. XML source: https://github.com/godotengine/godot/tree/4.3/../_plugins/Terrain3D/doc/doc_classes/Terrain3DEditor.xml.
.. _class_Terrain3DEditor:

Terrain3DEditor
===============

**Inherits:** :ref:`Object<class_Object>`
**Inherits:**

.. rst-class:: classref-introduction-group

Expand All @@ -27,33 +27,33 @@ Methods
.. table::
:widths: auto

+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`apply_undo<class_Terrain3DEditor_method_apply_undo>`\ (\ data\: :ref:`Dictionary<class_Dictionary>`\ ) |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`backup_region<class_Terrain3DEditor_method_backup_region>`\ (\ region\: :ref:`Terrain3DRegion<class_Terrain3DRegion>`\ ) |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Operation<enum_Terrain3DEditor_Operation>` | :ref:`get_operation<class_Terrain3DEditor_method_get_operation>`\ (\ ) |const| |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Terrain3D<class_Terrain3D>` | :ref:`get_terrain<class_Terrain3DEditor_method_get_terrain>`\ (\ ) |const| |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Tool<enum_Terrain3DEditor_Tool>` | :ref:`get_tool<class_Terrain3DEditor_method_get_tool>`\ (\ ) |const| |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`is_operating<class_Terrain3DEditor_method_is_operating>`\ (\ ) |const| |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`operate<class_Terrain3DEditor_method_operate>`\ (\ position\: :ref:`Vector3<class_Vector3>`, camera_direction\: :ref:`float<class_float>`\ ) |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_brush_data<class_Terrain3DEditor_method_set_brush_data>`\ (\ data\: :ref:`Dictionary<class_Dictionary>`\ ) |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_operation<class_Terrain3DEditor_method_set_operation>`\ (\ operation\: :ref:`Operation<enum_Terrain3DEditor_Operation>`\ ) |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_terrain<class_Terrain3DEditor_method_set_terrain>`\ (\ terrain\: :ref:`Terrain3D<class_Terrain3D>`\ ) |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_tool<class_Terrain3DEditor_method_set_tool>`\ (\ tool\: :ref:`Tool<enum_Terrain3DEditor_Tool>`\ ) |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`start_operation<class_Terrain3DEditor_method_start_operation>`\ (\ position\: :ref:`Vector3<class_Vector3>`\ ) |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`stop_operation<class_Terrain3DEditor_method_stop_operation>`\ (\ ) |
+--------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------+
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`apply_undo<class_Terrain3DEditor_method_apply_undo>`\ (\ data\: ``Dictionary``\ ) |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`backup_region<class_Terrain3DEditor_method_backup_region>`\ (\ region\: :ref:`Terrain3DRegion<class_Terrain3DRegion>`\ ) |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Operation<enum_Terrain3DEditor_Operation>` | :ref:`get_operation<class_Terrain3DEditor_method_get_operation>`\ (\ ) |const| |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Terrain3D<class_Terrain3D>` | :ref:`get_terrain<class_Terrain3DEditor_method_get_terrain>`\ (\ ) |const| |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`Tool<enum_Terrain3DEditor_Tool>` | :ref:`get_tool<class_Terrain3DEditor_method_get_tool>`\ (\ ) |const| |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``bool`` | :ref:`is_operating<class_Terrain3DEditor_method_is_operating>`\ (\ ) |const| |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`operate<class_Terrain3DEditor_method_operate>`\ (\ position\: ``Vector3``, camera_direction\: ``float``\ ) |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_brush_data<class_Terrain3DEditor_method_set_brush_data>`\ (\ data\: ``Dictionary``\ ) |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_operation<class_Terrain3DEditor_method_set_operation>`\ (\ operation\: :ref:`Operation<enum_Terrain3DEditor_Operation>`\ ) |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_terrain<class_Terrain3DEditor_method_set_terrain>`\ (\ terrain\: :ref:`Terrain3D<class_Terrain3D>`\ ) |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`set_tool<class_Terrain3DEditor_method_set_tool>`\ (\ tool\: :ref:`Tool<enum_Terrain3DEditor_Tool>`\ ) |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`start_operation<class_Terrain3DEditor_method_start_operation>`\ (\ position\: ``Vector3``\ ) |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| |void| | :ref:`stop_operation<class_Terrain3DEditor_method_stop_operation>`\ (\ ) |
+--------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+

.. rst-class:: classref-section-separator

Expand Down Expand Up @@ -237,7 +237,7 @@ Method Descriptions

.. rst-class:: classref-method

|void| **apply_undo**\ (\ data\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`🔗<class_Terrain3DEditor_method_apply_undo>`
|void| **apply_undo**\ (\ data\: ``Dictionary``\ ) :ref:`🔗<class_Terrain3DEditor_method_apply_undo>`

Undo the previous changes, with the provided data. Used by Godot, not gamedevs.

Expand Down Expand Up @@ -297,7 +297,7 @@ Returns the current tool selected in the editor plugin.

.. rst-class:: classref-method

:ref:`bool<class_bool>` **is_operating**\ (\ ) |const| :ref:`🔗<class_Terrain3DEditor_method_is_operating>`
``bool`` **is_operating**\ (\ ) |const| :ref:`🔗<class_Terrain3DEditor_method_is_operating>`

Returns true if currently in the middle of a brushing operation.

Expand All @@ -309,7 +309,7 @@ Returns true if currently in the middle of a brushing operation.

.. rst-class:: classref-method

|void| **operate**\ (\ position\: :ref:`Vector3<class_Vector3>`, camera_direction\: :ref:`float<class_float>`\ ) :ref:`🔗<class_Terrain3DEditor_method_operate>`
|void| **operate**\ (\ position\: ``Vector3``, camera_direction\: ``float``\ ) :ref:`🔗<class_Terrain3DEditor_method_operate>`

Start brushing.

Expand All @@ -321,7 +321,7 @@ Start brushing.

.. rst-class:: classref-method

|void| **set_brush_data**\ (\ data\: :ref:`Dictionary<class_Dictionary>`\ ) :ref:`🔗<class_Terrain3DEditor_method_set_brush_data>`
|void| **set_brush_data**\ (\ data\: ``Dictionary``\ ) :ref:`🔗<class_Terrain3DEditor_method_set_brush_data>`

Sets all brush settings used in the editor plugin.

Expand Down Expand Up @@ -369,7 +369,7 @@ Sets the tool selected in the editor plugin.

.. rst-class:: classref-method

|void| **start_operation**\ (\ position\: :ref:`Vector3<class_Vector3>`\ ) :ref:`🔗<class_Terrain3DEditor_method_start_operation>`
|void| **start_operation**\ (\ position\: ``Vector3``\ ) :ref:`🔗<class_Terrain3DEditor_method_start_operation>`

Begin a sculpting or painting operation.

Expand Down
Loading

0 comments on commit 6605c07

Please sign in to comment.