godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
34,234 Commits 15 Branches 59 Tags 2.2 GiB
Commit Graph

46 Commits

Author SHA1 Message Date
Rémi Verschelde 0a8d5d7098 Bump version to 3.6-beta 2022-08-05 18:51:38 +02:00
Hugo Locurcio b087538119
Add an XML schema for documentation 
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.
 2022-03-16 23:01:02 +01:00
Rémi Verschelde eac0d90c39
Merge pull request #55560 from pycbouh/docs-overridden-cross-linked-3.x 
[3.x] Make overridden properties link to parent definition
 2021-12-10 12:42:09 +01:00
Yuri Sizov 1cf6d21f69 Make overridden properties link to parent definition 
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
 2021-12-03 17:48:49 +03:00
Yuri Sizov ebd8101546 Sort and group theme properties in docs, improve formatting for theme and enums 2021-12-01 22:48:17 +03:00
Rémi Verschelde 14c366ddd7
Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
Hugo Locurcio 622f0b7d38
Document that most emoji won't display correctly on Windows 2021-09-15 18:52:21 +02:00
Yuri Sizov fcbe5a3fde Add theme item descriptions to the online documentation 2021-08-06 18:20:51 +03: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 6d58ea6ce7
Fix doc typos 
This pull request fixes an assortment of typos and improves conciseness in `Animation`, `Area2D`,  `Array`, `ArrayMesh`, `Control`, `Directory`, `EditorPlugin`, `Engine`, and `OS`.

(cherry picked from commit 9a72b0d3d0)
 2021-07-24 01:06:38 +02:00
Nick H d08717d0ee
Amend `Label`.clip_text() Method Description 
This update fixes an inconsistencies in the documentation about the `clip_text()` method.

(cherry picked from commit ea94aeac48)
 2021-06-29 14:02:23 +02:00
Rémi Verschelde c3272997cd
doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
Rémi Verschelde 1aba997d75
doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +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
skyace65 b181b97b6c Fix label percent visible doc description 
(cherry picked from commit a09aeefa1d)
 2020-06-15 14:34:35 +02:00
Tomasz Chabora 21dd35b611 Document theme_items of multiple classes 2020-01-27 02:15:37 +01: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
Rémi Verschelde 4eff13d768 doc: Markup fixes for enums and constants 2019-12-06 23:09:20 +01: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
Bojidar Marinov b397bcf4a1
Run doctool after overridden properties changes 2019-09-04 15:26:08 +03: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 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 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
Rémi Verschelde 39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
Ignacio Etcheverry 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
Rémi Verschelde d1f68e2eaf Add tooltip for in-editor FPS display in 3D viewport 
Also enhance Control/Label documentation about tooltips and mouse filter,
as it took me a while to understand why Labels didn't show tooltips.

Closes #26082.
 2019-02-20 12:16:22 +01:00
Thomas ten Cate 922f2d613f Fix return value of get_total_character_count 
Also document that it only counts visible characters.

Fixes #23720
 2018-11-15 12:34:08 +01:00
Rémi Verschelde 3d9deda8b3 Sync classref with current source 2018-05-12 09:38:00 +02: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
Bojidar Marinov ad79c70300
Update docs 
[ci skip]
 2018-01-12 00:58:22 +02:00
Rémi Verschelde 7251c5b582 Improve Control and Label documentation about mouse filtering 
Fixes #9657.
 2018-01-09 17:40:19 +01:00
Rémi Verschelde 7dfba3cda9 doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00
Rémi Verschelde 92f07fefcd doc: Remove setters and getters now exposed via properties/members 2017-11-24 18:10:32 +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
Jérôme GULLY 9e93f5b478 [DOCS] Review and improve 17 classes (#11890) 2017-10-09 12:49:12 +02:00
Nathan dfb3386184 Write TextureRect, Label and NinePatchRect 2017-09-16 21:09:43 +02:00
Rémi Verschelde a4005221f5 doc: Sync classref with current source 
[ci skip]
 2017-09-13 08:53:01 +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