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

35 Commits

Author SHA1 Message Date
VolTer 2792b520a7 Overhaul the top sections of the class reference (GUI classes) 
(cherry picked from commit 151a4ba6a5)
 2023-06-16 14:56:34 +02:00
Hana a5e5f1aa50 fix warnings in classref 2022-11-20 19:25:13 +01:00
bruvzg 74ff5921d6 Improve popup window handling. 
Add window FLAG_POPUP and a platform specific routines to control popup auto-hiding and event forwarding.
 2022-02-25 09:33:27 +02:00
Hugo Locurcio b68dd2e189
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-02-15 00:03:31 +01:00
Markus Sauermann ba565bec1b Update Popup and PopupMenu descriptions 2022-02-09 18:59:41 +01:00
Yuri Sizov b3992f7e6e Make overridden properties link to parent definition 
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
 2021-12-03 17:47:22 +03:00
Aaron Franke d54f2ad7ca
Don't generate empty doc sections and reduce code duplication 2021-09-20 20:59:33 -05:00
Nick Huelin 27e9df7778 Add multiple descriptions to several classes 
This pull request adds several descriptions to multiple different classes.

This improves the completeness of the documentation and enhances usability by doing so.
 2021-07-06 07:40:27 -04:00
Rémi Verschelde c6dcf3310d
doc: Sync classref with Variant utility methods 
Copied relevant documentation from the original `@GDScript` built-ins,
which will likely be removed in a future commit.

Various fixups to `variant_utility.cpp` while working on this.
 2020-11-17 11:26:24 +01:00
Rémi Verschelde e5033d3952 doc: Sync classref with DisplayServer/Window changes 2020-03-31 11:56:58 +02: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
HaSa1002 5be5f65440 document popup behaviour 2019-11-27 11:47:19 +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
Fabian 97167209cb Exposed set_as_minsize to gdscript 2019-08-14 16:09:55 +09:30
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
homer666 80e9e93e27 Add Popup::popup_centered_clamped method 
- Also replace redundant duplicate code in editor dialogs with calls to popup_centered_clamped()
 2019-04-30 05:35:43 +10:00
Rémi Verschelde 6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Rémi Verschelde 39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
Rémi Verschelde 6cdcde7114 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01:00
Cameron Reikes 3697dc0fc1 Clarify what popup_centered actually does 
As was discussed in issue #24309, the method description doesn't
always accurately describe resultant behavior and can be
confusing.
 2018-12-14 19:14:51 -08:00
Rémi Verschelde 3d9deda8b3 Sync classref with current source 2018-05-12 09:38:00 +02:00
homer666 d4ce53b9b1 [DOCS] Popup.popup_exclusive description 2018-04-22 05:41:15 +10: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 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
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