Commit Graph

30 Commits

Author SHA1 Message Date
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
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
71d53637b5 doc: Fix scoped hyperlinks to same-class enums/methods
The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
f34c8015cb Area2D: Fix argument type of body_* signals
Those signals receive either a PhysicsBody2D or a TileMap object,
and what the emitting method checks internally is only that the
object is a Node. In theory any Node could go through these signals
if they talk directly to the PhysicsServer2D.

Also updated docs.

Fixes #27076.

Might need further (compat breaking) improvement as this API is a
bit confusing, cf. #24739.
2019-06-24 21:40:31 +02: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
a15620c83e doc: Fix wrong references found by Sphinx and new makerst.py 2019-01-07 12:15:01 +01:00
ee6f1fa3f8 doc: Fix references to setters and misc formatting 2018-12-29 00:17:09 +01:00
6cdcde7114 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01:00
1dc8e7c05f Improve ClassDB information for some some signal parameters 2018-09-01 18:05:51 +08:00
29f2571662 update class docs 2018-08-31 22:35:15 +02:00
fdd0f18959 [DOCS] Small fix to Area: Fix copy/paste errors 2018-03-03 10:52:14 +01: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
e633a04c42 Update documentation to clarify that list of overlaps is not updated immediately. 2018-01-11 11:19:12 -03:00
61d833a56e [DOCS] Area members and methods 2017-12-06 08:46:52 -06:00
7dfba3cda9 doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00
92f07fefcd doc: Remove setters and getters now exposed via properties/members 2017-11-24 18:10:32 +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
b302084395 makerst: Fix rst-ization of members and escaping of [Class]s
Fixes #11517.
2017-10-21 12:33:52 +02:00
0843d2379c [DOCS] Area/Area2D class ref update 2017-09-24 00:24:41 -07:00
62cb43bb8d doc: Sync classref with current source
[ci skip]
2017-09-16 01:46:29 +02:00
a4005221f5 doc: Sync classref with current source
[ci skip]
2017-09-13 08:53:01 +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