gaming/godot
gaming/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot synced 2024-09-16 02:17:12 +00:00
Code Issues Packages Projects Releases Wiki Activity
51364 commits 13 branches 57 tags 4.1 GiB
Commit graph

69 commits

Author SHA1 Message Date
Hana a5e5f1aa50 fix warnings in classref 2022-11-20 19:25:13 +01:00
Haoyu Qiu 5da515773d Add is_finite method for checking built-in types 2022-10-08 13:25:08 +08:00
Aaron Franke 995b9f94e8
Replace Rect2(i) has_no_area with has_area 2022-09-04 23:03:36 -05:00
Andy Maloney 1df86ecea5 [doc] Use "param" instead of "code" to refer to parameters (4) 2022-08-11 13:52:19 -04:00
Yuri Sizov c5d7115038 Rename the argument tag to param in XML documentation 2022-08-08 22:34:31 +03:00
Yuri Roubinsky 32f2c47356 Remove generating of null comparison operators from documentation 2022-03-14 22:35:23 +03: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
Hugo Locurcio 10e7977be3
Clarify documentation for Rect2/Rect2i's has_no_area() 2022-02-01 18:00:05 +01:00
Aaron Franke 9687f6fca3
Warn when using an AABB or Rect2 with a negative size 2021-11-30 18:27:58 -06:00
Rémi Verschelde 471e7cbfc7
Merge pull request #54581 from aaronfranke/operator-docs 2021-11-16 14:10:09 +01:00
Rémi Verschelde 6c1bd4d227
Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 13:02:21 +01:00
Rémi Verschelde 36c4451a7b
Rect2: Clarify docs for has_point excluding bottom and right borders 
Improve tests, as well as documentation for `expand`.
 2021-11-11 22:51:29 +01:00
Aaron Franke 813466b3c8
Add documentation to operators for math types 
Co-authored-by: Raul Santos <raulsntos@gmail.com>
 2021-11-04 14:44:55 -05:00
Aaron Franke 6772ebcea0
Move the docs for constructors and operators out of methods section 2021-10-29 12:34:57 -05:00
Rémi Verschelde 862994a8ef
doc: Update links to latest documentation after content reorganization 2021-10-06 13:48:48 +02:00
Rémi Verschelde ba57252bd8
Merge pull request #52878 from AnilBK/add-get-center 2021-09-21 21:30:30 +02:00
Anilforextra 90908cd67d Add Get Center Method for Rect2/Rect2i and AABB. 2021-09-21 21:14:17 +05:45
Aaron Franke d54f2ad7ca
Don't generate empty doc sections and reduce code duplication 2021-09-20 20:59:33 -05:00
George Marques 455e142d37
Allow comparing equality between builtin types and null 2021-09-17 12:33:52 -03:00
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
Michael Alexsander Silva Dias 0ff4095b36 Better format arguments in variant parser 2021-06-18 00:06:40 -03:00
Paul Joannon 8455e901f3
class reference proofreading 2021-03-19 13:21:20 +01: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 215d18814e
doc: Sync classref with current source 2021-01-04 14:33:44 +01:00
Marcel Admiraal b628912af0 Rename Rect2 and Rect2i grow_margin() to grow_side() 2020-12-28 12:47:33 +00:00
Nathan Franke 3fda53c256
Update Rect intersection documentation, and rename method on Mono 2020-12-26 22:16:57 -06:00
Marcel Admiraal 4b8b803931 Rename Control margin to offset 2020-12-23 06:25:56 +00:00
Marcel Admiraal 2df9a8ccad Rename Rect2 and Rect2i clip() to intersection() 2020-12-19 12:59:08 +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
Aaron Franke 439be614f4
Link to demos from within the class reference 2020-10-01 23:57:21 -04:00
Hugo Locurcio e9eddb4f1f
Cross-reference AABB and Rect2 in the class reference 2020-09-21 14:27:50 +02: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
Aaron Franke 83e324d670
Update core documentation to match recent C# changes 
Also a few minor API changes like adding AABB.abs()

Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
 2020-07-21 14:44:53 -04: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 471271b727 doc: Sync classref with current source 2020-03-09 10:13:45 +01:00
Michael Alexsander 8c8c48a7ad Turn Rect2's 'intersects_touch()' into an extra argument of 'intersects()' 2020-03-04 09:32:34 -03:00
Rémi Verschelde 6c8f2ae53a Update docs and bindings for new integer vector types 2020-02-25 15:27:29 +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
Aaron Franke 3231fca934
Add docs for is_equal_approx on structures 2019-11-30 16:52:27 -05:00
Rémi Verschelde 1f76229378 doc: Sync classref with current source 2019-11-08 08:33:48 +01: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 6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +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
Chris Bradfield 454b701e76 [DOCS] minor classref updates 2019-03-14 11:36:12 -07:00