Haoyu Qiu
144e3cd31f
Fix various misused code tag in classref
...
(cherry picked from commit 85c136bd07
)
2021-12-02 17:31:16 +01:00
Rémi Verschelde
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
Hugo Locurcio
4914b57222
Enable Doppler preview in the 3D editor by default
...
This makes setting up AudioStreamPlayer3D nodes for Doppler playback
a bit easier.
- Move AudioStreamPlayer3D's Doppler Tracking property outside a group
since the group only had 1 property, which resulted in unnecessary
folding in the inspector.
- Put the AudioStreamPlayer3D Playing and Autoplay properties higher up
in the inspector since these are likely to be modified often.
2021-09-17 18:51:09 +02:00
Max Hilbrunner
f8e3840913
Merge pull request #49039 from madmiraal/fix-docs-3407-3.x
...
[3.x] Clarify documentation of Camera.get_camera_transform()
2021-09-16 00:22:06 +02:00
Rémi Verschelde
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
Nicholas Huelin
bd8747f7f1
Fix miscellaneous doc typos and inconsistencies
...
This pull request fixes an assortment of typos, improves conciseness, and enhances clarity.
(cherry picked from commit 9787e631aa
)
2021-07-24 01:00:37 +02:00
Aaron Franke
753d0fca1d
[3.x] Fix Camera FOV documentation
2021-05-31 05:25:12 -04:00
Marcel Admiraal
cfc984aff1
Clarify documentation of Camera3D.get_camera_transform()
2021-05-24 17:54:53 +01:00
Rémi Verschelde
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
Paul Joannon
596169d7df
class reference proofreading
...
(cherry picked from commit 8455e901f3
)
2021-03-26 09:49:07 +01:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
Hugo Locurcio
7746afec94
Document hiding a Control when its reference point is behind the camera
...
See https://github.com/godotengine/godot/issues/1725 .
(cherry picked from commit b3a6937c0c
)
2020-10-28 14:05:42 +01:00
Aaron Franke
069ed4ec63
Link to demos from within the class reference
...
(cherry picked from commit 439be614f4
)
2020-10-19 16:10:01 +02: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
73149499c0
Improve the Camera class documentation
...
This makes the Camera class 100% documented.
2019-12-03 09:37:01 +01:00
Rémi Verschelde
6c557b8bdf
Camera: Don't set default value for project_position
...
A z_depth of 0 returns the camera position, which is not really useful.
This also makes the API breakage from 3.1 clearer as 3.1 code will now
fail to compile, so users will have to adapt and use the new parameter.
For the reference, in 3.1, the z_depth was hardcoded to the near plane.
Closes #33493 .
2019-11-10 00:17:26 +01:00
Rémi Verschelde
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02:00
Rémi Verschelde
b9aa13e591
doc: Remove hardcoded default values from descriptions
...
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02:00
Rémi Verschelde
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
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
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
Rémi Verschelde
0e441e9a1a
Merge pull request #29248 from Cheeseness/camera_project_fix
...
Add a depth parameter to Camera::project_position()
2019-05-28 19:25:37 +02:00
Rémi Verschelde
3a365c1fc0
doc: Sync classref with current source
2019-05-28 18:08:13 +02:00
Cheeseness
6fe957de63
Add a depth parameter to Camera::project_position()
2019-05-29 02:04:50 +10:00
Jummit
ce2c45bde7
add get_camera_rid method
2019-05-27 16:05:27 +02:00
Jiří Procházka
04b49264f2
Small documentation improvements
2019-05-01 11:11:09 +02:00
Juan Linietsky
325f6c6581
Added inspector plugin documentation.
...
Fixed plugin bindings.
2019-04-23 16:39:09 -03:00
Rémi Verschelde
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Tomasz Chabora
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Rémi Verschelde
74932b905e
doc: Sync classref with current source
2019-02-10 13:01:03 +01:00
Rémi Verschelde
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
Rémi Verschelde
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
Poommetee Ketson
72aa87758a
Update classref and docs, fix missing parameters' name
2018-04-11 10:20:22 +07:00
Rémi Verschelde
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
Mel Collins
99110772c0
[DOCS] Tweaks and fixes for (Interpolated)Camera
2018-04-03 15:58:21 +02:00
Poommetee Ketson
b099a500eb
s/Camear/Camera in docs
2018-03-02 23:20:14 +07: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
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
Rémi Verschelde
8d03cafd7c
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
Will Nations
d9cb00151b
[DOCS] Camera property changes
2017-12-11 12:48:41 -06:00
Rémi Verschelde
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
Rémi Verschelde
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01: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
b1f2c31a36
doc: Sync classref with current source
...
Ensure that s/fixed_process/physics_process/ is handled properly.
[ci skip]
2017-10-11 23:55:04 +02:00
mhilbrunner
255f30a9b7
[DOCS] Camera documentation
2017-10-07 20:04:42 +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