d29095027b
clarify what duplicate does and its limitations
...
(cherry picked from commit a6108f8a3d
2021-09-21 17:15:00 +02:00
f0b37b1519
doc: Point URLs to 3.4 version of the online docs
2021-08-12 17:08:10 +02:00
f5836b40d4
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.
(cherry picked from commit 7adf4cc9b5
2021-08-03 10:20:19 +02:00
822b3ec0b1
Document `Resource.duplicate()` only copying exported variables' values
...
(cherry picked from commit 2ba893e3ce
2021-06-01 12:53:31 +02:00
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
015973df04
doc: Make all tutorial links point to 3.3 branch of docs
2021-03-26 10:43:43 +01:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
22bb9fcd82
Document a built-in use of `Resource.resource_name`
...
(cherry picked from commit 1a606b1a04
2021-01-26 17:00:16 +01:00
b124c0c466
Expose `Resource.emit_changed()` to script
...
Also known as `emit_signal("changed")`.
(cherry picked from commit e94f46dcdb
2021-01-15 16:49:46 +01:00
45cdb8aab3
Remove the implication that references and resources are not objected from their description
...
(cherry picked from commit dca298d22b
2021-01-13 16:17:10 +01:00
99a6cf77dd
Mention that 'changed' signal needs manual emit
...
(cherry picked from commit b552c26c68
2020-12-10 13:03:25 +01:00
9706b78a3f
Document C# garbage collection caveats in Reference and Resource
...
(cherry picked from commit 0565c76e8b
2020-11-26 09:38:47 +01:00
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 16:10:01 +02:00
b717a61903
Improve the Object, Reference and Resource class documentations
...
(cherry picked from commit 4275e6aad5
2020-07-28 00:48:33 +02:00
8f0d50c3ec
Update Resource.xml to explain behavior of duplicate when subresources is true and a subresource contains further nested resources.
...
Updated documentation for duplicate() on Resource to better explain the behavior. As per #30385 .
(cherry picked from commit 660a780c3b
2020-07-10 09:00:02 +02:00
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
c6cea6e9b3
doc: Add default values to all properties
...
Thanks to @bojidar-bg's impressive work in #29380 .
2019-06-30 13:58:07 +02:00
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
867dda1124
doc: Proofread and complete various nodes
...
All 100% completed: MainLoop, Node, Object, Path, Performance,
Reference, Resource, SceneState, SceneTree, UndoRedo.
Also fixed some en_GB occurrences as the reference spelling is en_US.
2019-06-26 23:05:51 +02:00
0764451dc5
doc: Improve docs for Resource* classes
...
Also move module-specific classes to their own module's `doc_classes`
folder.
2019-06-18 20:07:26 +02:00
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
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
63d3a42f82
Merge pull request #27465 from neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough
...
EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-05 15:19:21 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
d80bc5cbba
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]
...
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 23:47:35 +01:00
8cc3ae11da
Small improvements to the Resource doc
2019-02-17 10:37:23 -03:00
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
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
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
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
92f07fefcd
doc: Remove setters and getters now exposed via properties/members
2017-11-24 18:10:32 +01:00
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
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
fc09e14366
classref: Sync with current source
...
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00
a4005221f5
doc: Sync classref with current source
...
[ci skip]
2017-09-13 08:53:01 +02:00
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
Jummit
Rémi Verschelde
Hugo Locurcio
Andrii Doroshenko (Xrayez)
skyace65
Tomasz Chabora
Bob Gardner
Ignacio Etcheverry
Michael Alexsander Silva Dias
Juan Linietsky