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

34 Commits

Author SHA1 Message Date
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
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
Hugo Locurcio 483f8e0ef8
Improve AudioStreamGenerator and AudioEffectSpectrumAnalyzer documentation 
- Mention audio sample rate caveats in other classes where relevant.

(cherry picked from commit c872819be6)
 2021-06-17 12:47:52 +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
Hugo Locurcio ab4ea9379c Improve the AudioStreamSample class documentation 
This closes #37915.

(cherry picked from commit 52786b54ef)
 2020-04-16 12:57:22 +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
Rémi Verschelde 4eff13d768 doc: Markup fixes for enums and constants 2019-12-06 23:09:20 +01:00
Hugo Locurcio b0c8d12a63
Improve AudioStreamSample and AudioStreamGenerator documentation 
- Add a link to the audio generator demo in AudioStreamGenerator
  and AudioStreamGeneratorPlayback.
- Mention that signed PCM8 data is expected in AudioStreamSample
  (and how to convert unsigned PCM8 to signed PCM8).
 2019-08-31 20:16:04 +02:00
Rémi Verschelde b9aa13e591 doc: Remove hardcoded default values from descriptions 
They are now generated automatically by doctool.
 2019-06-30 13:58:07 +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
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
follower a3aa98cb88
Improve AudioStreamSample documentation. 
"Squash" of #27928.

Wording based on suggestions by @LikeLakers2.
 2019-05-31 00:20:33 +12: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
merumelu db8f26c8e5 AudioStreamSample: Don't crash when writing to file fails 2019-03-12 15:51:07 +01:00
MrCdK b2bfcb53d6 Add backward looping support to AudioStreamSample (wav files) 2018-10-28 19:37:14 +01:00
Rémi Verschelde 4ea3e4f551 doc: Sync classref with current source 2018-08-21 00:35:46 +02:00
Zumo ef74954e66 Fully exposes data variable on AudioStreamSample/AudioStreamOGGVorbis... 
...and also changes "_set_data" and "_get_data" to "set_data" and "get_data" respectively.
 2018-05-01 12:19:15 +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
Bojidar Marinov ad79c70300
Update docs 
[ci skip]
 2018-01-12 00:58:22 +02:00
Rémi Verschelde 624a2b08f3 doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc 2017-12-07 08:29:38 +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
Grosskopf 10269b74c8 Added Documentation of AudioStream 2017-09-17 13:48:10 +02:00
Rémi Verschelde 62cb43bb8d doc: Sync classref with current source 
[ci skip]
 2017-09-16 01:46:29 +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