2e8fdd0112
Fix typos with codespell
...
Using codespell 2.1.0.
Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
curvelinear
dof
doubleclick
fave
findn
GIRD
leapyear
lod
merchantibility
nd
numer
ois
ony
que
readded
seeked
statics
synching
te
uint
unselect
webp
EOF
$ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"
$ git diff // undo unwanted changes
```
(cherry picked from commit b197de6f5f
2022-01-07 00:17:47 +01:00
56f66aa8fc
Clarify that resize doesn't initialize memory
...
Some users might expect resize() to initialize added elements to zero. This clarifies that it is not the case.
2021-10-09 13:46:04 -03:00
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
c1135cf006
Work on porting HTTPRequest compression to 3.3
...
Fix doc issues
Use memcpy
Bind RESULT_BODY_DECOMPRESS_FAILED
Docs update
2021-05-14 12:20:31 +03:00
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
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
c09b9c488f
Complete documentation of some more classes
2020-01-14 13:19:39 +01:00
475115c0c3
Added empty() function to pool array types
2019-10-31 16:27:32 +01:00
1349e0e585
doc: Sync classref with current source
...
Fix wrong hyperlinks in Control and Tree.
2019-08-22 14:49:30 +02:00
7402fd2c56
Revert "Feature: Add SHA256 for PoolByteArray"
...
This reverts commit e2c3bbabb0#29871 which adds more crypto features with a
dedicated interface.
Since this commit was never in a stable release (merged during 3.2 dev),
we revert it to avoid having to deprecate it in favor of the Crypto API.
See https://github.com/godotengine/godot/pull/31187#issuecomment-523377965
2019-08-22 13:44:57 +02:00
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
426bcc9941
Change "Return" to "Returns" where necessary in XML documentation
...
In many of the XML files it had been noted that when the documentation
refers to a return value, both "Return" and "Returns" are used. This
has now been fixed to only say "Returns".
Fixes #28867
2019-05-23 21:11:24 -07:00
325f6c6581
Added inspector plugin documentation.
...
Fixed plugin bindings.
2019-04-23 16:39:09 -03:00
f2d3d3e679
Merge pull request #24269 from xsellier/feature/master-add-sha256
...
Add SHA256 for PoolByteArray
2019-04-23 06:38:03 +03:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
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
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
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
26fddb77be
doc: Fix wrong references found by new makerst.py
...
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
e2c3bbabb0
Feature: Add SHA256 for PoolByteArray
2018-12-10 14:58:47 -05:00
eaac1e3b81
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes
2018-09-23 16:13:30 -04:00
3e0ab0a2f2
Standardize documentation for the pool arrays' invert methods
2018-09-12 06:33:11 +08:00
6b797574a2
[DOCS] Add note that Pool*Arrays are passed by value ( #18340 )
2018-04-22 01:23:50 +02:00
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
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
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
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
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
fc09e14366
classref: Sync with current source
...
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00
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
