65 Commits

Author SHA1 Message Date
Rémi Verschelde
95e913285d Bump version to 3.6-beta 2022-08-05 18:51:38 +02:00
Hugo Locurcio
ab7886cfd4 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
Max Hilbrunner
19e301ea59 Fix docs links in 3.x after docs reorg 2022-01-05 11:54:52 +01:00
Rémi Verschelde
2178a7fb3e Replace Godot docs URL with $DOCS_URL in XML class reference 2021-11-15 17:22:47 +01:00
Rémi Verschelde
663122285b Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
David Cambré
5e23250c8c Update VisualScriptCustomNode.xml
(cherry picked from commit c697a773a5)
2021-09-21 17:14:59 +02:00
Rémi Verschelde
3b70def536 doc: Point URLs to 3.4 version of the online docs 2021-08-12 17:08:10 +02:00
Rémi Verschelde
02ee17f9a2 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 6846557be1)
2021-08-03 10:20:19 +02:00
Rémi Verschelde
767ffaefc3 Expose visual script custom node type hints 2021-07-21 19:33:10 +02:00
Tomasz Chabora
b1410bc498 Document remaining Visual Script classes
(cherry picked from commit 7f3186137e)
2021-07-15 10:46:04 +02:00
Rémi Verschelde
ce22b8440e Style: Cleanup uses of double spaces between words
Or after punctuation. Tried to leave third-party stuff alone, unless it has
been heavily modified for Godot.

(cherry picked from commit 8fad8b7035)
2021-06-07 12:06:59 +02:00
Rémi Verschelde
8e7a44c537 doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
Rémi Verschelde
648bf9291b doc: Make all tutorial links point to 3.3 branch of docs 2021-03-26 10:43:43 +01:00
Rémi Verschelde
8588d87ca6 doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
Rémi Verschelde
827e36b581 doc: Warn about using Node internal processing
See #43689.

Also 'fixed' some spelling for behavior in publicly visible strings.
(Sorry en_GB, en_CA, en_AU, and more... Silicon Valley won the tech spelling
war.)

(cherry picked from commit a655de89e3abc14baff7a95deb85fe4daed7361c)
2020-11-26 09:38:45 +01:00
Rémi Verschelde
8d10725cf2 doc: Sync classref with current source 2020-10-19 17:13:30 +02:00
Rémi Verschelde
5766590ef4 doc: Make docs.godotengine.org links point to 3.2 branch 2020-10-19 16:10:01 +02:00
Rémi Verschelde
183d22b0ef DocData: Skip language-specific ClassDoc without methods/constants
Removes the useless `@C#`, `@NativeScript` and `@VisualScript` entries.

(cherry picked from commit ba0db95909a232e3f4d694294f077c9460ef00ce)
2020-06-18 11:29:28 +02:00
Rémi Verschelde
87d6172967 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
4128510769 doc: Misc updates for AnimationNode* and others
- Add some missing descriptions.
- Add links to tutorials for ARVR and AnimationTree.
- Style fixes.
- Engine changes:
  * Make `AnimationNodeTransition.input_<number>` properties internal
    so that they don't appear in the docs. They still appear in the
    inspector based on the actual number of inputs requested.
  * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D
    particles in `ParticlesMaterial`, and thus only relevant for
    `CPUParticles3D`.
2020-01-23 12:37:33 +01:00
Rémi Verschelde
fa4c6b8f82 doc: Markup fixes for enums and constants 2019-12-06 23:09:20 +01:00
Rémi Verschelde
577e45081c doc: Sync classref with current source
And various fixes to bindings, hyperlinks and an uninitialized variable.
2019-09-27 22:16:42 +02:00
Swarnim Arun
3d8b00c657 Visualscript editor graph unification & refactoring
Removes the need to have separate graphs per function for the VisualScript Nodes, and refactoring UI and other improvements such as fuzzy search, right click search boxes and in-graph editable nodes
2019-09-26 01:53:58 +05:30
Rémi Verschelde
839df54085 doc: Sync classref with current source
Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 11:52:06 +02:00
Rémi Verschelde
e4f1b32c85 doc: Sync classref with current source 2019-07-22 12:27:52 +02:00
Chaosus
add37970b3 Added lerp_angles built-in function
Co-authored-by: Xrayez <https://github.com/Xrayez>
Co-authored-by: DleanJeans <https://github.com/DleanJeans>
2019-07-20 12:59:41 +03:00
Rémi Verschelde
1ac70b9e1b doc: Sync classref with current source 2019-07-15 20:45:30 +02:00
Rémi Verschelde
d7f65527ae doc: Remove null default values that can't be determined
Applying #30187.
2019-06-30 13:58:07 +02:00
Rémi Verschelde
feade426af 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
23af85f606 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
b2d81c90e3 doc: Don't use GlobalScope scope in hyperlinks, it's automatically inferred 2019-06-27 14:43:37 +02:00
Rémi Verschelde
9798e341c3 doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks 2019-06-27 13:49:36 +02:00
Rémi Verschelde
be74f53090 doc: Complete and harmonize all _MAX constant descriptions 2019-06-27 11:10:53 +02:00
Rémi Verschelde
294f681a08 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
Giacom
959a4f59e6 Added move_toward functions for float, Vector2 and Vector3 2019-05-28 11:39:35 +01:00
Rémi Verschelde
37b0001e08 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
946e3039b9 doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Tomasz Chabora
a3abff255d Consistently wrap booleans in [code] 2019-04-17 17:13:00 +02:00
Rémi Verschelde
e2e90aa566 Merge pull request #27231 from Chaosus/smoothstep
Added smoothstep built-in function
2019-04-08 10:03:42 +02:00
Chaosus
dd9357d41c Added smoothstep built-in function 2019-04-07 14:11:26 +03:00
Rémi Verschelde
e742fe2f23 doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
Rémi Verschelde
d695667ac4 doc: Misc formatting fixes 2019-02-10 13:30:48 +01:00
Rémi Verschelde
55afdd1433 doc: Fix wrong references found by new makerst.py
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
Rémi Verschelde
f0decb2459 doc: Sync classref with current source
Fix various code formatting issues and argument names.
2018-12-27 11:10:18 +01:00
Rémi Verschelde
16b11edd76 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01:00
Rémi Verschelde
ff00ea931a doc: Another indentation fixup 2018-11-20 10:20:00 +01:00
Rémi Verschelde
259c39f81d doc: Use HTTPS for docs.godotengine.org and point to latest branch
Fixes #23509.
2018-11-05 08:46:27 +01:00
robojumper
13c8549ae7 Add support for tutorial links to makerst.py
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02:00
Will Vincent
24b151a48c Remove incorrect & potentially confusing references to Euler
e is referred to as Euler’s number, so technically the MATH_EXP description in VisualScript doc was not incorrect, though could potentially lead to confusion.

e is different from Euler’s constant however, making the existing GDScript exp & VisualScriptMathConstant descriptions nvalid.
2018-04-15 11:40:31 -05:00
Rémi Verschelde
9639987678 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