Commit 5648c29f authored by adud's avatar adud

added a first idea of what could be the API

parent c8a8c2b1
......@@ -13,4 +13,5 @@ the
[style guide](https://docs.godotengine.org/en/latest/getting_started/\scripting/gdscript/gdscript_styleguide.html)
described in Godot Documentation.
When creating a class or a function, describe it in the API chapter of the documentation
The API follows the same style as [Godot API](https://docs.godotengine.org/en/latest/classes/index.html)
.. _SignSymb:
==========
SignSymb
==========
.. warning::
For the moment, SignSymb is only a dummy text display that is used to test
the :ref:`WorkSpace`
.. _WorkSpace:
===========
WorkSpace
===========
Inherits from the Container class.
-----------------
Brief Description
-----------------
Container used to prompt the speech in a text-editor way.
----------
Properties
----------
.. _class_WorkSpace_prop_sep:
* Vector2 **sep**
The sizes in pixel of the horizontal and vertical separators between two
words.
.. _class_WorkSpace_prop_text:
* Array **text**
The signs of the speech in a big "string".
==============
Software API
==============
.. toctree::
:maxdepth: 1
:glob:
class-*
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment