Commit Graph

23 Commits

Author SHA1 Message Date
Rémi Verschelde
6846557be1 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
84271acf1d Better format arguments in variant parser 2021-06-18 00:06:40 -03:00
Rémi Verschelde
8fad8b7035 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.
2021-06-07 11:03:08 +02:00
Swarnim Arun
d82e2ea20d Fix doc for the VisualScript class. 2021-01-05 00:15:53 +05:30
Hugo Locurcio
87f2ca7d57 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
Rémi Verschelde
e2e76facc3 doc: Sync classref with StringName/Callable changes 2020-02-22 14:59:09 +01:00
clayjohn
7e07e45db6 Update docs to version 4.0 2020-01-31 17:15:41 -08: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
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
946e3039b9 doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Rémi Verschelde
e742fe2f23 doc: Bump version to 3.2 2019-04-01 12:33:56 +02: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
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
Rémi Verschelde
d2244b063a doc: Update version string in header 2018-02-19 10:46:33 +01:00
Rémi Verschelde
40b57494dc doc: Fix references to online tutorials after godotengine/godot-docs#1015 2018-01-25 09:03:59 +01:00
Rémi Verschelde
0ddacdab12 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
bd42ba7d0c doc: Replace some more "val" with "value" + sync 2018-01-17 10:43:23 +01:00
Juan Linietsky
0f66947e58 Filled tutorial field in most relevent classes.
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
Rémi Verschelde
9cb8f46319 doc: Update version string in XML 2018-01-13 11:43:42 +01:00
Rémi Verschelde
e62947ec6c doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc 2017-12-07 08:29:38 +01:00
Rémi Verschelde
bc6b6c43d4 doc: Update header version for 3.0-beta 2017-11-24 09:16:52 +01:00
Rémi Verschelde
55e453ed89 doc: Make all module docs self-contained 2017-11-15 21:29:33 +01:00