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
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
Hugo Locurcio
1ab3ddf94a
Allow using WOFF fonts in DynamicFont
...
This is already supported by FreeType, but it wasn't exposed.
Adding support for WOFF2 would require linking a Brotli decompression
library in Godot, so only WOFF1 is exposed here.
2021-08-25 08:09:23 +02: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
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
follower
0d8cbd5d8c
Doc clarity/detail for extra spacing properties
...
Re: Space spacing being in addition to character spacing see:
* <d7b85fbaa1/scene/resources/dynamic_font.cpp (L858-L859)https://github.com/godotengine/godot/issues/38630 >
But also note that nodes other than `Label` may not currently render extra space spacing correctly.
(cherry picked from commit 2ef89e0b43
2020-09-29 13:57:58 +02:00
Hugo Locurcio
c040e8f93a
Document missing character behavior when drawing text with fonts
...
See #40405 .
(cherry picked from commit 7735d8d0ce
2020-09-04 08:50:32 +02:00
Hugo Locurcio
d4740ee643
Document the lack of kerning support in DynamicFont
...
(cherry picked from commit e506479fce
2020-08-17 11:04:32 +02:00
Pedro J. Estébanez
06904ac215
Add DynamicFont::get_available_chars()
2020-07-20 17:45:04 +02:00
Rémi Verschelde
253fc093b8
DocData: Skip unexposed classes
...
Properly expose classes that we actually want accessible.
(cherry picked from commit 0ef8bcac4d
2020-04-21 14:15:34 +02:00
Hugo Locurcio
4e73fcc959
Document DynamicFont limitations and a possible workaround
...
This closes #30014 .
(cherry picked from commit 46b8e108e2
2020-04-20 11:55:04 +02: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
Hugo Locurcio
673bd79a9e
Improve the DynamicFont class documentation
2019-12-03 09:56:11 +01:00
Rémi Verschelde
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02:00
Rémi Verschelde
542489a866
DocData: Re-expose parametric setters and getters
...
Setters and getters have been hidden from the documentation when the matching
properties have been exposed, but some of them are parametric and require the
name or index of a given parameter to be used. So they need to be properly
documented with the type and name of the arguments they take.
For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-07-04 14:08:16 +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
Hein-Pieter van Braam
2779bdf557
Merge pull request #27724 from follower/patch-2
...
Add example of loading a font from .ttf file
2019-04-23 06:04:25 +03:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
follower
c89cc44a5e
Add example of loading a font from .ttf file
...
As this is a multi-step process it would be nice to have this documented.
2019-04-06 23:06:08 +13: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
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
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
b302084395
makerst: Fix rst-ization of members and escaping of [Class]s
...
Fixes #11517 .
2017-10-21 12:33:52 +02:00
Dio
f43e49b1c0
[DOCS] DynamicFont
2017-10-12 16:37:45 +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
