classref: Fix links case and sync headers with editor

Output from godotengine/godot#22002.
This commit is contained in:
Rémi Verschelde
2018-09-13 01:56:41 +02:00
parent 942b6d3ac1
commit f9caa4be29
579 changed files with 16363 additions and 16329 deletions

View File

@@ -7,8 +7,7 @@
EditorFileSystemDirectory
=========================
**Inherits:** :ref:`Object<class_object>`
**Inherits:** :ref:`Object<class_Object>`
**Category:** Core
Brief Description
@@ -16,35 +15,35 @@ Brief Description
A diretory for the resource filesystem.
Member Functions
----------------
Methods
-------
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_dir_index<class_EditorFileSystemDirectory_find_dir_index>` **(** :ref:`String<class_string>` name **)** const |
| :ref:`int<class_int>` | :ref:`find_dir_index<class_EditorFileSystemDirectory_find_dir_index>` **(** :ref:`String<class_String>` name **)** const |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`find_file_index<class_EditorFileSystemDirectory_find_file_index>` **(** :ref:`String<class_string>` name **)** const |
| :ref:`int<class_int>` | :ref:`find_file_index<class_EditorFileSystemDirectory_find_file_index>` **(** :ref:`String<class_String>` name **)** const |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_file<class_EditorFileSystemDirectory_get_file>` **(** :ref:`int<class_int>` idx **)** const |
| :ref:`String<class_String>` | :ref:`get_file<class_EditorFileSystemDirectory_get_file>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_file_count<class_EditorFileSystemDirectory_get_file_count>` **(** **)** const |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`bool<class_bool>` | :ref:`get_file_import_is_valid<class_EditorFileSystemDirectory_get_file_import_is_valid>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_file_path<class_EditorFileSystemDirectory_get_file_path>` **(** :ref:`int<class_int>` idx **)** const |
| :ref:`String<class_String>` | :ref:`get_file_path<class_EditorFileSystemDirectory_get_file_path>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_file_script_class_extends<class_EditorFileSystemDirectory_get_file_script_class_extends>` **(** :ref:`int<class_int>` idx **)** const |
| :ref:`String<class_String>` | :ref:`get_file_script_class_extends<class_EditorFileSystemDirectory_get_file_script_class_extends>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_file_script_class_name<class_EditorFileSystemDirectory_get_file_script_class_name>` **(** :ref:`int<class_int>` idx **)** const |
| :ref:`String<class_String>` | :ref:`get_file_script_class_name<class_EditorFileSystemDirectory_get_file_script_class_name>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_file_type<class_EditorFileSystemDirectory_get_file_type>` **(** :ref:`int<class_int>` idx **)** const |
| :ref:`String<class_String>` | :ref:`get_file_type<class_EditorFileSystemDirectory_get_file_type>` **(** :ref:`int<class_int>` idx **)** const |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_name<class_EditorFileSystemDirectory_get_name>` **(** **)** |
| :ref:`String<class_String>` | :ref:`get_name<class_EditorFileSystemDirectory_get_name>` **(** **)** |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_parent<class_EditorFileSystemDirectory_get_parent>` **(** **)** |
| :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` | :ref:`get_parent<class_EditorFileSystemDirectory_get_parent>` **(** **)** |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`String<class_string>` | :ref:`get_path<class_EditorFileSystemDirectory_get_path>` **(** **)** const |
| :ref:`String<class_String>` | :ref:`get_path<class_EditorFileSystemDirectory_get_path>` **(** **)** const |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` | :ref:`get_subdir<class_EditorFileSystemDirectory_get_subdir>` **(** :ref:`int<class_int>` idx **)** |
| :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` | :ref:`get_subdir<class_EditorFileSystemDirectory_get_subdir>` **(** :ref:`int<class_int>` idx **)** |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`int<class_int>` | :ref:`get_subdir_count<class_EditorFileSystemDirectory_get_subdir_count>` **(** **)** const |
+--------------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------+
@@ -54,24 +53,24 @@ Description
A more generalized, low-level variation of the directory concept.
Member Function Description
---------------------------
Method Descriptions
-------------------
.. _class_EditorFileSystemDirectory_find_dir_index:
- :ref:`int<class_int>` **find_dir_index** **(** :ref:`String<class_string>` name **)** const
- :ref:`int<class_int>` **find_dir_index** **(** :ref:`String<class_String>` name **)** const
Returns the index of the directory with name ``name`` or ``-1`` if not found.
.. _class_EditorFileSystemDirectory_find_file_index:
- :ref:`int<class_int>` **find_file_index** **(** :ref:`String<class_string>` name **)** const
- :ref:`int<class_int>` **find_file_index** **(** :ref:`String<class_String>` name **)** const
Returns the index of the file with name ``name`` or ``-1`` if not found.
.. _class_EditorFileSystemDirectory_get_file:
- :ref:`String<class_string>` **get_file** **(** :ref:`int<class_int>` idx **)** const
- :ref:`String<class_String>` **get_file** **(** :ref:`int<class_int>` idx **)** const
Returns the name of the file at index ``idx``.
@@ -89,45 +88,45 @@ Returns ``true`` if the file at index ``idx`` imported properly.
.. _class_EditorFileSystemDirectory_get_file_path:
- :ref:`String<class_string>` **get_file_path** **(** :ref:`int<class_int>` idx **)** const
- :ref:`String<class_String>` **get_file_path** **(** :ref:`int<class_int>` idx **)** const
Returns the path to the file at index ``idx``.
.. _class_EditorFileSystemDirectory_get_file_script_class_extends:
- :ref:`String<class_string>` **get_file_script_class_extends** **(** :ref:`int<class_int>` idx **)** const
- :ref:`String<class_String>` **get_file_script_class_extends** **(** :ref:`int<class_int>` idx **)** const
.. _class_EditorFileSystemDirectory_get_file_script_class_name:
- :ref:`String<class_string>` **get_file_script_class_name** **(** :ref:`int<class_int>` idx **)** const
- :ref:`String<class_String>` **get_file_script_class_name** **(** :ref:`int<class_int>` idx **)** const
.. _class_EditorFileSystemDirectory_get_file_type:
- :ref:`String<class_string>` **get_file_type** **(** :ref:`int<class_int>` idx **)** const
- :ref:`String<class_String>` **get_file_type** **(** :ref:`int<class_int>` idx **)** const
Returns the file extension of the file at index ``idx``.
.. _class_EditorFileSystemDirectory_get_name:
- :ref:`String<class_string>` **get_name** **(** **)**
- :ref:`String<class_String>` **get_name** **(** **)**
Returns the name of this directory.
.. _class_EditorFileSystemDirectory_get_parent:
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_parent** **(** **)**
- :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` **get_parent** **(** **)**
Returns the parent directory for this directory or null if called on a directory at ``res://`` or ``user://``.
.. _class_EditorFileSystemDirectory_get_path:
- :ref:`String<class_string>` **get_path** **(** **)** const
- :ref:`String<class_String>` **get_path** **(** **)** const
Returns the path to this directory.
.. _class_EditorFileSystemDirectory_get_subdir:
- :ref:`EditorFileSystemDirectory<class_editorfilesystemdirectory>` **get_subdir** **(** :ref:`int<class_int>` idx **)**
- :ref:`EditorFileSystemDirectory<class_EditorFileSystemDirectory>` **get_subdir** **(** :ref:`int<class_int>` idx **)**
Returns the subdirectory at index ``idx``.