Skip to content
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.

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

Update links to source code files in core/ #4367

Merged
merged 1 commit into from
Nov 15, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions development/cpp/common_engine_methods_and_macros.rst
Original file line number Diff line number Diff line change
Expand Up @@ -237,10 +237,10 @@ Godot features many error macros to make error reporting more convenient.

.. seealso::

See `core/error_macros.h <https://github.com/godotengine/godot/blob/master/core/error_macros.h>`__
See `core/error/error_macros.h <https://github.com/godotengine/godot/blob/master/core/error/error_macros.h>`__
in Godot's codebase for more information about each error macro.

Some functions return an error code (materialized by a return type of
``Error``). This value can be returned directly from an error macro.
See the list of available error codes in
`core/error_list.h <https://github.com/godotengine/godot/blob/master/core/error_list.h>`__.
`core/error/error_list.h <https://github.com/godotengine/godot/blob/master/core/error/error_list.h>`__.
16 changes: 8 additions & 8 deletions development/cpp/core_types.rst
Original file line number Diff line number Diff line change
Expand Up @@ -165,10 +165,10 @@ The Vector<> class also has a few nice features:
References:
~~~~~~~~~~~

- `core/vector.h <https://github.com/godotengine/godot/blob/master/core/vector.h>`__
- `core/list.h <https://github.com/godotengine/godot/blob/master/core/list.h>`__
- `core/set.h <https://github.com/godotengine/godot/blob/master/core/set.h>`__
- `core/map.h <https://github.com/godotengine/godot/blob/master/core/map.h>`__
- `core/templates/vector.h <https://github.com/godotengine/godot/blob/master/core/templates/vector.h>`__
- `core/templates/list.h <https://github.com/godotengine/godot/blob/master/core/templates/list.h>`__
- `core/templates/set.h <https://github.com/godotengine/godot/blob/master/core/templates/set.h>`__
- `core/templates/map.h <https://github.com/godotengine/godot/blob/master/core/templates/map.h>`__

String
------
Expand All @@ -181,7 +181,7 @@ conversion and visualization.
References:
~~~~~~~~~~~

- `core/ustring.h <https://github.com/godotengine/godot/blob/master/core/ustring.h>`__
- `core/string/ustring.h <https://github.com/godotengine/godot/blob/master/core/string/ustring.h>`__

StringName
----------
Expand All @@ -197,7 +197,7 @@ is fast.
References:
~~~~~~~~~~~

- `core/string_name.h <https://github.com/godotengine/godot/blob/master/core/string_name.h>`__
- `core/string/string_name.h <https://github.com/godotengine/godot/blob/master/core/string/string_name.h>`__

Math types
----------
Expand All @@ -219,7 +219,7 @@ referencing them fast.
References:
~~~~~~~~~~~

- `core/node_path.h <https://github.com/godotengine/godot/blob/master/core/node_path.h>`__
- `core/string/node_path.h <https://github.com/godotengine/godot/blob/master/core/string/node_path.h>`__

RID
---
Expand All @@ -232,4 +232,4 @@ referenced data.
References:
~~~~~~~~~~~

- `core/rid.h <https://github.com/godotengine/godot/blob/master/core/rid.h>`__
- `core/templates/rid.h <https://github.com/godotengine/godot/blob/master/core/templates/rid.h>`__
8 changes: 4 additions & 4 deletions development/cpp/custom_godot_servers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ an initialization state and a cleanup procedure.
private:
uint64_t counter;
RID_Owner<InfiniteBus> bus_owner;
// https://github.com/godotengine/godot/blob/master/core/rid.h#L196
// https://github.com/godotengine/godot/blob/master/core/templates/rid.h
Set<RID> buses;
void _emit_occupy_room(uint64_t room, RID rid);

Expand Down Expand Up @@ -204,7 +204,7 @@ an initialization state and a cleanup procedure.
return ret;
}

// https://github.com/godotengine/godot/blob/master/core/rid.h#L187
// https://github.com/godotengine/godot/blob/master/core/templates/rid.h
bool HilbertHotel::delete_bus(RID id) {
if (bus_owner.owns(id)) {
lock();
Expand Down Expand Up @@ -316,7 +316,7 @@ References
~~~~~~~~~~~

- :ref:`RID<class_rid>`
- `core/rid.h <https://github.com/godotengine/godot/blob/master/core/rid.h>`__
- `core/templates/rid.h <https://github.com/godotengine/godot/blob/master/core/templates/rid.h>`__

Registering the class in GDScript
---------------------------------
Expand Down Expand Up @@ -474,7 +474,7 @@ to execute the desired behavior. The queue will be flushed whenever either
References:
~~~~~~~~~~~

- `core/message_queue.cpp <https://github.com/godotengine/godot/blob/master/core/message_queue.cpp>`__
- `core/object/message_queue.cpp <https://github.com/godotengine/godot/blob/master/core/object/message_queue.cpp>`__

Summing it up
-------------
Expand Down
4 changes: 2 additions & 2 deletions development/cpp/custom_resource_format_loaders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ path again, the previous loaded Resource will be referenced. Naturally,
loaded resources must be stateless.

This guide assumes the reader knows how to create C++ modules and Godot
data types. If not, refer to this guide :ref:`doc_custom_modules_in_c++`.
data types. If not, refer to this guide: :ref:`doc_custom_modules_in_c++`

References
~~~~~~~~~~
Expand Down Expand Up @@ -304,7 +304,7 @@ References

- `istream <http://www.cplusplus.com/reference/istream/istream/>`_
- `streambuf <http://www.cplusplus.com/reference/streambuf/streambuf/?kw=streambuf>`_
- `core/io/fileaccess.h <https://github.com/godotengine/godot/blob/master/core/os/file_access.h>`_
- `core/io/file_access.h <https://github.com/godotengine/godot/blob/master/core/os/file_access.h>`_

Registering the new file format
-------------------------------
Expand Down
8 changes: 4 additions & 4 deletions development/cpp/object_class.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ This makes Objects gain a lot of functionality, like for example
References:
~~~~~~~~~~~

- `core/object.h <https://github.com/godotengine/godot/blob/master/core/object.h>`__
- `core/object/object.h <https://github.com/godotengine/godot/blob/master/core/object/object.h>`__

Registering an Object
---------------------
Expand Down Expand Up @@ -93,7 +93,7 @@ string passing the name can be passed for brevity.
References:
~~~~~~~~~~~

- `core/class_db.h <https://github.com/godotengine/godot/blob/master/core/class_db.h>`__
- `core/object/class_db.h <https://github.com/godotengine/godot/blob/master/core/object/class_db.h>`__

Constants
---------
Expand Down Expand Up @@ -258,7 +258,7 @@ templates point to it.
References:
~~~~~~~~~~~

- `core/reference.h <https://github.com/godotengine/godot/blob/master/core/reference.h>`__
- `core/object/reference.h <https://github.com/godotengine/godot/blob/master/core/object/reference.h>`__

Resources:
----------
Expand All @@ -274,7 +274,7 @@ Resources without a path are fine too.
References:
~~~~~~~~~~~

- `core/resource.h <https://github.com/godotengine/godot/blob/master/core/resource.h>`__
- `core/io/resource.h <https://github.com/godotengine/godot/blob/master/core/io/resource.h>`__

Resource loading
----------------
Expand Down
6 changes: 3 additions & 3 deletions development/cpp/variant_class.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ of C++ with little effort. Become a friend of Variant today.
References:
~~~~~~~~~~~

- `core/variant.h <https://github.com/godotengine/godot/blob/master/core/variant.h>`__
- `core/variant/variant.h <https://github.com/godotengine/godot/blob/master/core/variant/variant.h>`__

Containers: Dictionary and Array
--------------------------------
Expand All @@ -56,5 +56,5 @@ Copy-on-write (COW) mode support for containers was dropped with Godot 3.0.
References:
~~~~~~~~~~~

- `core/dictionary.h <https://github.com/godotengine/godot/blob/master/core/dictionary.h>`__
- `core/array.h <https://github.com/godotengine/godot/blob/master/core/array.h>`__
- `core/variant/dictionary.h <https://github.com/godotengine/godot/blob/master/core/variant/dictionary.h>`__
- `core/variant/array.h <https://github.com/godotengine/godot/blob/master/core/variant/array.h>`__