Rémi Verschelde
7adf4cc9b5
doc: Use self-closing tags for return
and argument
...
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
2021-07-30 15:29:52 +02:00
Lightning_A
b6af2a29eb
Rename is_valid_integer()
to is_valid_int()
...
Method from `String`
2021-06-16 10:32:22 -06:00
Hugo Locurcio
5ea1c75d63
Rename String.is_abs_path()
to String.is_absolute_path()
...
This is more consistent with `NodePath.is_absolute()`.
2021-06-03 16:00:06 +02:00
Tomasz Chabora
b1859510ab
Change behavior of String.right
2021-05-20 23:07:57 +02:00
Rémi Verschelde
4ca1e73ff9
doc: Sync classref with current source
...
And move GLTF docs to its module folder.
2021-03-18 16:37:43 +01:00
Rémi Verschelde
83b1acdc60
Merge pull request #45545 from abaire/relaxes_gltf_name_sanitization
...
Relaxes node name sanitization in gltf documents.
2021-03-09 14:54:33 +01:00
HaSa1002
bae843a1c9
Docs: Port Code Examples to C# (R, S, T, U)
...
* RenderingServer
* RichTextEffect
* SceneTree
* SceneTreeTimer
* ScriptCreateDialog
* SpinBox
* Sprite2D
* StreamPeer
* String
* SurfaceTool
* TextEdit
* TileMap
* Tree
* Tween
* UDPServer
* UndoRedo
Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2021-03-05 18:57:28 +01:00
abaire
61cc1c8624
Relaxes Node naming constraints in glTF documents to match the Editor.
2021-02-24 08:22:27 -08:00
Aaron Franke
e829b7aee4
Unify URI encoding/decoding and add to C#
...
http_escape and percent_encode have been unified into uri_encode, and http_unescape and percent_decode have been unified into uri_decode.
2021-01-28 07:45:01 -05:00
Aaron Franke
a3e3bf8227
Make hex_to_int and bin_to_int handle the prefix automatically
...
Also add BinToInt to C#
2021-01-28 07:43:53 -05:00
Yuri Roubinsky
38a5d22079
Renamed String.ord_at to unicode_at
2021-01-26 20:36:12 +03:00
Andrii Doroshenko (Xrayez)
a2c82bbf5f
Clarify lstrip()/rstrip()
methods in String
for removed characters
2021-01-10 15:13:59 +02:00
Rémi Verschelde
215d18814e
doc: Sync classref with current source
2021-01-04 14:33:44 +01:00
Marcel Admiraal
5b937d493f
Rename empty() to is_empty()
2020-12-28 10:39:56 +00:00
Rémi Verschelde
64e893deac
doc: Sync classref to add operators after #43419
2020-11-10 15:00:50 +01:00
Rémi Verschelde
0f249f5c0a
Variant: Sync docs with new constructors, fixups after #43403
...
Change DocData comparators for MethodDoc and ArgumentDoc to get a better
ordering of constructors.
2020-11-09 23:39:53 +01:00
Rémi Verschelde
424cd00f8b
doc: Sync classref with current source + fixup some bindings
...
Includes various changes triggered by the refactoring of method bindings.
2020-11-04 15:38:26 +01:00
Rémi Verschelde
42f2098509
Merge pull request #42435 from Calinou/doc-string-is-valid-ip-address
...
Improve the `String.is_valid_ip_address()` documentation
2020-10-01 12:54:27 +02:00
Hugo Locurcio
00ade39389
Improve the String.is_valid_ip_address()
documentation
...
This closes https://github.com/godotengine/godot-docs/issues/4097 .
2020-09-30 19:26:14 +02:00
Hugo Locurcio
a2271ba3bd
Improve the String comparison methods' documentation
...
This closes https://github.com/godotengine/godot-docs/issues/4096 .
2020-09-30 19:08:20 +02:00
bruvzg
80b8eff6aa
[Complex Test Layouts] Change String
to use UTF-32 encoding on all platforms.
2020-09-03 19:56:24 +03:00
Hugo Locurcio
c4903a603b
Add link titles for all links in the class reference
...
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
2020-08-31 14:22:07 +02:00
Hugo Locurcio
5f2b6bd476
Document how to perform advanced string splitting using RegEx
...
This closes https://github.com/godotengine/godot-docs/issues/3607 .
2020-07-29 12:12:01 +02:00
Hugo Locurcio
4275e6aad5
Improve the Object, Reference and Resource class documentations
2020-07-27 10:03:46 +02:00
Hugo Locurcio
04b25108ac
Document which escape sequences are supported by String.c_unescape()
...
See https://github.com/godotengine/godot/issues/38716 .
2020-07-15 11:52:00 +02:00
Rémi Verschelde
9cec315ec0
Merge pull request #40103 from Calinou/doc-fix-string-capitalize
...
Fix `String.capitalize()` description to follow camelCase changes
2020-07-04 09:57:46 +02:00
Hugo Locurcio
887099680a
Fix String.capitalize()
description to follow camelCase changes
...
This closes #40093 .
2020-07-03 20:36:27 +02:00
Stijn Hinlopen
929b98d24b
Remove String::find_last (same as rfind)
2020-07-03 15:26:22 +02:00
Meriipu
2643b8fa5e
Clarify what a string being empty means
...
Should close https://github.com/godotengine/godot-docs/issues/2432
2020-06-23 11:13:12 +02:00
Hugo Locurcio
7f01f68226
Document the in
operator in String, Array and Dictionary classes
...
This also clarifies the `in` operator behavior in Object.
2020-06-12 19:22:35 +02:00
Rémi Verschelde
bbdfc7353c
doc: Sync classref with current source
2020-05-11 13:23:39 +02:00
Mateo Kuruk Miccino
8c2dc177b6
GDScript: Add join method on String
...
Docs: Add join on String.xml
2020-05-09 12:16:21 -03:00
Rémi Verschelde
788765709d
DocData: Fix serialization of Variant default values
...
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2020-03-09 10:52:44 +01:00
Rémi Verschelde
a7e1df4b1d
doc: Sync classref for Packed{Int,Float}{32,64}Array additions
2020-02-25 22:02:36 +01:00
Rémi Verschelde
6c8f2ae53a
Update docs and bindings for new integer vector types
2020-02-25 15:27:29 +01:00
Rémi Verschelde
fea37cfb52
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
Rémi Verschelde
213a85521d
doc: Sync classref with current source
...
Handle removal of Pool*Array types and other recent changes.
2020-02-18 14:02:02 +01:00
clayjohn
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
Rémi Verschelde
2d20fc39aa
doc: Drop unused 'category' property from header
...
We already removed it from the online docs with #35132 .
Currently it can only be "Built-In Types" (Variant types) or "Core"
(everything else), which is of limited use.
We might also want to consider dropping it from `ClassDB` altogether
in Godot 4.0.
2020-01-26 16:02:39 +01:00
Hugo Locurcio
ae76c62601
Implement Node::get_process_priority()
and its associated property
...
This closes #33660 .
2019-11-17 17:48:50 +01:00
Rémi Verschelde
d3a852f124
Merge pull request #33591 from zaksnet/fix-string-docs-split
...
Fix split/rsplit docs
2019-11-13 14:03:14 +01:00
Zak
79aca6b0c0
Fix split/rsplit docs
2019-11-13 14:58:19 +02:00
Rémi Verschelde
121fb46ab9
Clarify that String.insert returns a copy
...
Supersedes and closes #32620 .
2019-11-07 13:12:06 +01:00
Andrii Doroshenko (Xrayez)
a0d00c0e99
Bind the String::humanize_size
method
...
The method signature is also changed to use `uint64_t` instead of `size_t`
for it to be Variant-compatible.
2019-10-04 15:51:13 +03:00
Rémi Verschelde
a7ac8ec876
doc: Fix parsing of self-closing XML tags
...
Follow-up to #31925 , `<member />` tags just before `</members>` would cause
a parsing issue, and we'd never notice that we're no longer parsing members.
Also added space before closing `/>`.
2019-09-24 13:34:05 +02:00
Bhupendra Aole
073f625a91
Create a GDScript String function repeat
...
Fixes #30610
2019-09-03 13:06:13 -04:00
Rémi Verschelde
051b5b3d15
doc: Sync classref with current source
2019-07-29 21:12:57 +02:00
Chaosus
080c0bb7fe
Added count method to String
2019-07-23 18:55:54 +03:00
Rémi Verschelde
6d4850b8b8
Merge pull request #30412 from Larpon/docs/string-hex_to_int-improve
...
Improve hex_to_int documentation
2019-07-08 08:12:04 +02:00
lmp
bb89cf6ab0
Provide documentation for String http_escape() and http_unescape() methods
2019-07-07 21:15:06 +02:00
lmp
cebb38e0b3
Clearify how hex_to_int expects a '0x' prefixed string. Provide a small hex_to_int example
2019-07-07 21:12:03 +02:00
Rémi Verschelde
343dcd9029
doc: Sync classref with current source
2019-07-05 10:58:45 +02:00
Hugo Locurcio
f7f6115f76
Proofread and improve the whole class reference
...
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
2019-06-27 22:30:19 +02:00
Rémi Verschelde
5e21310343
doc: Sync classref with current source
2019-06-24 10:39:59 +02:00
Rémi Verschelde
2b52cd3e5c
Merge pull request #28648 from KoBeWi/substr-1
...
Make second parameter of substr optional
2019-06-19 12:43:46 +02:00
Zak
1a397f46e6
Improved documentation of rsplit Method for String class.
...
Improved documentation of rsplit Method for String class.
Removed "divisor" (i will also change variants_call.cpp) and added "delimiter" in its place. Also moved the example at the bottom of the description.
2019-06-11 13:39:18 +03:00
Rémi Verschelde
e92c09ba4e
doc: Make all tutorial links track "latest" in master branch
...
While the master branch is in development state for the next stable branch,
its links should point to the "latest" docs branch, to ensure that users of
the unstable builds are linked to the relevant documentation.
Those links could be switched to stable branch subdomains before branching
off for a new major or minor release, to start tracking the frozen stable
docs branches.
See discussion in #29104 .
2019-06-01 11:33:34 +02:00
Rémi Verschelde
af2c742f53
Fix and expose String::strip_escapes(), use it in LineEdit paste
...
Supersedes #27736 .
2019-05-31 15:49:14 +02:00
Michael Alexsander Silva Dias
3197898c88
Add "String Formatting" tutorial link to the 'String' doc
2019-05-16 23:07:52 -03:00
Tomasz Chabora
0b8a785539
Make second parameter of substr optional
2019-05-03 19:46:56 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Rémi Verschelde
09e94aa087
doc: Sync classref with current source
2019-04-15 14:49:41 +02:00
Michael Alexsander Silva Dias
70499faff8
Document String's 'is_valid_filename()'
2019-04-11 21:48:40 -03:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Rémi Verschelde
26fddb77be
doc: Fix wrong references found by new makerst.py
...
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
Andrii Doroshenko (Xrayez)
b8f1fe9ed8
Bind is_valid_hex_number
string method to GDScript
2018-12-24 20:54:36 +02:00
Alexander Holland
e4b2a20cd6
Filled missing Doc for String and FileDialog
2018-10-12 04:46:24 +02:00
Rémi Verschelde
f92b87e5f8
DocData: Fix return type listed as "var" instead of "Variant"
2018-08-31 22:41:14 +02:00
Michael Alexsander Silva Dias
79ab43299a
Small doc formating changes and Linux cursor theme note
2018-08-05 04:07:04 -03:00
Rémi Verschelde
4c5dd51eb9
Sync classref with current source
...
Also fix binding of Basis.slerp
2018-05-28 14:53:15 +02:00
Max Hilbrunner
acf6c326fb
Merge pull request #14715 from Krakean/string_add_rsplit2
...
Added rsplit() method to String class
2018-05-23 17:19:35 +02:00
bosak
79ecdee496
add string trim_prefix trim_suffix lstrip and rstrip methods
2018-04-17 14:15:43 +03:00
Rémi Verschelde
3fa77b3172
doc: Remove status from hardcoded version string
...
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 13:40:49 +01:00
Rémi Verschelde
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
Rémi Verschelde
d516aab8fa
doc: Sync with current source
...
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018
and fix the version tag in all files (not really stable yet, but it makes no sense
to hardcode rc3 at this stage).
2018-01-25 08:50:56 +01:00
Anutrix
6d4c6449f4
Added description to dedent in String.xml
2018-01-19 15:57:38 +05:30
Poommetee Ketson
d7e07fb25a
Merge pull request #15857 from YeldhamDev/find_last_doc
...
[DOCS] Fixed incorrect information inside String's "find_last" method
[ci skip]
2018-01-19 10:22:21 +07:00
Michael Alexsander Silva Dias
d8f6acee4b
[DOCS] Fixed incorrect information inside String's "find_last" method.
2018-01-19 00:10:33 -02:00
Rémi Verschelde
9f479f096c
Fix typos in code and docs with codespell
...
Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 22:01:42 +01:00
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
Dmitry Koteroff
6fe415ca7f
Added rsplit() for String class
...
Docs updated
2017-12-15 22:23:58 +03:00
Dmitry Koteroff
5302fd125b
Added third argument for String.split() function (see issue #14349 )
...
Remove negative limit, leave only positive and make it reflect behaviour like in Python
Also limit renamed to maxsplit to match Python one.
Also docs updated.
Fix indent
2017-12-15 21:51:13 +03:00
Rémi Verschelde
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
Ferenc Arn
d28763a4c1
Rename Rect3 to AABB.
...
Fixes #12973 .
2017-11-17 11:01:41 -05:00
Rémi Verschelde
967bfb0c4a
doc: Remove revision.module_config from version string
...
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00
Rémi Verschelde
2fce0010f0
classref: Sync with current source
...
[ci skip]
2017-11-13 09:25:53 +01:00
mhilbrunner
0608f2fca3
[DOCS] String
2017-10-23 00:11:09 +02:00
letheed
5ad9be4c24
Rename pos to position in user facing methods and variables
...
Rename user facing methods and variables as well as the corresponding
C++ methods according to the folloming changes:
* pos -> position
* rot -> rotation
* loc -> location
C++ variables are left as is.
2017-09-20 13:11:10 +02:00
Juan Linietsky
4f929a0fdf
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
...
recognize them.
2017-09-12 17:45:41 -03:00