Rémi Verschelde
130f8fa193
Rename KEY_KP_SUBSTRACT to KEY_KP_SUBTRACT
...
The former name was incorrect in English, though for us latin lovers it's an understandable mistake.
Second part of and closes #3626 .
2016-02-17 23:01:27 +01:00
Rémi Verschelde
e5389288dd
Add a warning header to each rst file
...
To tell potential contributors that they should direct their work to the XML template and not the auto-generated reST
2016-02-17 22:02:55 +01:00
Rémi Verschelde
9e4532d689
Implement support for [codeblock] tag in help
...
It allows to define a multiline space-indented code block that will be properly parsed by the reST converter for the online docs.
The in-editor help understand the [codeblock] tag as it supposedly understand [code] already (i.e. it just seems to discard it, though the code was supposed to switch it to a monospace font, but that's likely another issue.
2016-02-17 21:17:08 +01:00
Rémi Verschelde
281236280e
Fix NavigationPolygon references in _bind_method
...
Also sync the doc accordingly
2016-02-17 18:46:31 +01:00
Josh Grams
a0cffd625b
doc: explain DampedSpringJoint2D parameters.
2016-02-17 10:25:55 -05:00
Rémi Verschelde
747c1709aa
Merge pull request #3710 from AlexHolly/doc-directory
...
some doc for directory
2016-02-16 07:47:44 +01:00
Rémi Verschelde
5439937899
Bind method is_cell_transposed
2016-02-15 23:30:52 +01:00
Rémi Verschelde
76ff31b3ff
Fix some broken method references
...
+ sync template with source
2016-02-15 23:22:55 +01:00
Alexander Holland
e65838f2d0
some doc for directory
2016-02-14 20:31:55 +01:00
Rémi Verschelde
391a882218
Merge pull request #3699 from Hinsbart/doc_os_getname
...
Doc: add list of possible return values to OS.get_name() description
2016-02-13 14:32:50 +01:00
hondres
080b5e4f63
doc: add list of possible return values to OS.get_name() description
2016-02-13 15:24:01 +01:00
hondres
a415996f79
"Sync classes reference template with current code base"
2016-02-13 03:16:24 +01:00
Alexander Holland
260380be45
Doc HTTPClient.get_response_headers_as_dictionary()
2016-02-12 22:39:23 +01:00
Rémi Verschelde
f5433dc60d
Merge pull request #3627 from lordadamson/master
...
renamed function get_video_texutre to get_video_texture
2016-02-08 11:21:58 +01:00
Adham Zahran
6be6d02daf
renamed function get_video_texutre to get_video_texture
2016-02-08 12:11:26 +02:00
Rémi Verschelde
9998927cfd
Merge pull request #3625 from lordadamson/master
...
'radian' to 'radians' :D
2016-02-07 20:21:54 +01:00
Adham Zahran
485e772d37
just a small type
2016-02-07 21:17:13 +02:00
Rémi Verschelde
938772ac9f
Merge pull request #3624 from lordadamson/master
...
fixing typos all over the place
2016-02-07 20:15:26 +01:00
Adham Zahran
8161392eb6
fixing typos all over the place
2016-02-07 21:10:52 +02:00
Rémi Verschelde
6faa1b9288
Merge pull request #3619 from lordadamson/master
...
description for Input.is_mouse_button_pressed()
2016-02-07 19:22:18 +01:00
Adham Zahran
9d8b798d44
description for Input.is_mouse_button_pressed()
2016-02-07 19:48:23 +02:00
Rémi Verschelde
0f11b322b3
Improve parsing of [method ...] tags
...
Also improve some code display.
2016-02-07 18:30:18 +01:00
Rémi Verschelde
1af65aff44
Fix badly formatted tags in XML
...
Also add parsing of [code] tags in RST converter
2016-02-07 17:19:12 +01:00
Juan Linietsky
b766e9c79b
Display better inheritance info in doc
2016-02-07 13:05:16 -03:00
Rémi Verschelde
2fabb3e892
Small makerst improvements
2016-02-07 14:43:09 +01:00
Rémi Verschelde
47e5a5fd74
Enhance xml to rst converter
...
Fixes a number of issues:
- Headings underliners now have the correct length
- Newline+Tabs in descriptions are replaced by two newlines to make a proper paragraph
- [br] are replaced by two newlines, making a proper paragraph
- Properly parse internal hyperlinks in constants description
- Fix broken internal links due to missing newlines
- Show method header even when it has no description, to have something to reference in hyperlinks
2016-02-07 12:13:19 +01:00
Rémi Verschelde
c512dbfe5a
Sync classes ref with code
2016-02-07 11:18:38 +01:00
Rémi Verschelde
4a39202c8d
Merge pull request #3607 from 29jm/patch-1
...
Added get_cellv() method to TileMap
2016-02-07 00:33:43 +01:00
Juan Linietsky
3ee4f4f19a
-Added RST generator for class reference
2016-02-06 20:23:39 -03:00
Johan Manuel
a634fc7a4a
Added get_cellv() method to TileMap
2016-02-06 13:48:41 +01:00
Ovnuniarchos
51dfd4a4b5
Variables SpatialSoundServer and SS pointed to SpatialSound2DServer.
2016-01-30 10:36:58 +01:00
Rémi Verschelde
ac3aa29c24
Sync API reference with current code
2016-01-26 00:19:47 +01:00
hondres
de809f3ed9
replace InputEvent references with GlobalScope in joystick doc
2016-01-23 15:34:27 +01:00
Ovnuniarchos
8ed13c4df4
set_signed_data now works correctly on pcm8 samples.
2016-01-21 14:40:58 +01:00
Ovnuniarchos
37ee43fd5a
Documented AudioServserSW, EventPlayer and EventStream*. Corrections on AudioServer and Sample.
2016-01-21 01:17:17 +01:00
volzhs
4563a5909a
add documentation for OS::set_keep_screen_on
2016-01-16 20:59:44 +09:00
hondres
c632c13c66
Add some joystick functions to input. Enables manipulation of mappings at runtime
2016-01-08 00:40:41 +01:00
George Marques
5be9ff7b67
Update copyright to 2016 in headers
2016-01-01 11:50:53 -02:00
Ovnuniarchos
57ffdbc24c
PhysicsBody2D and descendants documented.
2015-12-28 21:53:05 +01:00
Rémi Verschelde
d4993b74fc
Add missing argument names in GDScript bindings
...
All classes were reviewed apart from VisualServer for which no argument name is documented at all.
While doing this review, I found quite a few bugs that were fixed either in earlier commits or this one (mostly documentation bugs though, i.e. some arguments were listed at the wrong place).
2015-12-28 02:13:05 +01:00
Rémi Verschelde
d1caf2f037
Remove bogus argument in body_get_node
2015-12-28 01:32:12 +01:00
Rémi Verschelde
46eebac3ae
Remove bogus argument in sample_get_description
...
Copy-paste mistake from the setter most likely.
2015-12-28 01:18:37 +01:00
Rémi Verschelde
e66f4a4021
Sync doc with current source
2015-12-27 23:06:13 +01:00
Ovnuniarchos
69a65e5a69
New area space override modes documented. Also, PhysicsBody2D, Area2D, and CollisionObject2D.
2015-12-22 15:48:41 +01:00
Rémi Verschelde
410e418aea
Add a Makefile to generate classes doc in various formats
...
All the generated documentation is put in doc/_build.
2015-12-13 00:01:04 +01:00
Rémi Verschelde
aeb5ea5934
Move documentation python tools to doc/tools folder
2015-12-12 23:30:45 +01:00
Rémi Verschelde
29f30b7deb
Move doxygen config to doc folder
...
Also removed logo_small.png and used logo.png instead
2015-12-12 21:18:33 +01:00
Rémi Verschelde
61eb037d5d
Remove outdated documentation
2015-12-12 21:18:33 +01:00
Juan Linietsky
ff936c6b2e
Merge pull request #2868 from akien-mga/pr-fix-can-move-to
...
Fix can_move_to and rename it for more clarity
2015-12-08 17:09:47 -03:00
Juan Linietsky
afb895f197
Merge pull request #2993 from leezh/nrex-v0.1
...
updated the RegEx library nrex to v0.1
2015-12-08 17:00:27 -03:00
Franklin Sobrinho
3c4b0236cb
Add constructor for Image built-in type
2015-12-06 09:12:14 -03:00
Zher Huei Lee
d957749179
updated nrex documentation
2015-12-04 22:19:53 +00:00
Bojidar Marinov
12f2c1378a
Edit documentation for AABB and Rect2.
...
Docs for AABB were already present, but had a few mistakes.
2015-11-29 15:56:40 +02:00
Bojidar Marinov
c81c671131
Run -doctool on existing documentation
...
Also, s/vecor/vector/
2015-11-29 15:38:47 +02:00
est31
323938cc28
Document byte conversion methods for Strings
2015-11-24 05:46:00 +01:00
Rémi Verschelde
a961347d8c
Fix return type of Matrix32 member vars
...
Thanks to @bojidar-bg for localising the issue.
2015-11-23 19:08:54 +01:00
Bojidar Marinov
4359a90cca
Document Vector3 and Vector3Array. Fix documentation of Vector2 and Vector2Array.
2015-11-23 14:18:13 +02:00
Bojidar Marinov
ca750fb7bc
Update doc with -doctool.
2015-11-23 13:57:57 +02:00
zvodd
18dfb16e26
fix poorly formed documentation xml, text outside of tags
2015-11-23 12:52:43 +11:00
Rémi Verschelde
2674565cf6
Merge pull request #1931 from Faless/audio_free_rid
...
Expose AudioServer::free(RID rid) as AudioServer.free_rid(RID rid)
2015-11-23 00:22:15 +01:00
Rémi Verschelde
e57dfe2663
Update doc for can_teleport_to
2015-11-22 14:21:04 +01:00
Rémi Verschelde
0c8dda80ff
Update Vector2.angle() description
2015-11-20 18:47:18 +01:00
Rémi Verschelde
497efa720c
Sync doc template with code
2015-11-20 18:39:23 +01:00
Ovnuniarchos
8c0c46c2ae
Inserted explanation about the behaviour of CollsionPolygon2D.set_polygon.
2015-11-20 18:24:28 +01:00
Ovnuniarchos
68a0f713b8
Differences between ConvexPolygon2D and ConcavePolygon2D?
2015-11-20 18:09:31 +01:00
Ovnuniarchos
1155ac884c
ConvexPolygonShape2D.set_point_cloud documented to do nothing.
2015-11-20 18:09:31 +01:00
Ovnuniarchos
73a80e5509
Added definition of bias solver.
2015-11-20 18:09:31 +01:00
Juan Linietsky
232b1a3fef
Merge pull request #2822 from kurikaesu/master
...
HTTPClient docs & request functionality + fixes
2015-11-19 09:18:09 -03:00
Aren Villanueva
5c7e9e7e63
Fixes the make_doc.sh, <, > and & signs in descriptions that cause the parser to break.
...
Documentation for HTTPClient.
Added a query_string_from_dict method to HTTPClient to create a x-www-form-urlencoded valid query string for GET and POST messages.
String now has http_escape() and http_unescape() methods to help facilitate the above query_string_from_dict method.
2015-11-19 22:01:42 +11:00
Ovnuniarchos
07110c3a14
Changed capabilities list.
2015-11-19 11:18:22 +01:00
Rémi Verschelde
3fcfdfec0a
Merge pull request #2645 from Ovnuniarchos/DocCurvePathPFollow
...
Documented classes Curve*, Path*, and PathFollow*
2015-11-07 13:15:47 +01:00
Ovnuniarchos
8abdb43aab
Documented classes Curve*, Path*, and PathFollow*
2015-11-07 13:09:00 +01:00
Ovnuniarchos
3b2899bc42
Regex class documented. For some reason, parameter descriptors don\'t appear.
2015-11-03 04:39:42 +01:00
Fabio Alessandrelli
203f069329
Expose AudioServer::free(RID rid) as AudioServer::free_rid(RID rid)
...
to avoid script error due to collision with Object method free
2015-11-02 17:54:33 +01:00
Rémi Verschelde
b2f9acb8c9
Merge pull request #2680 from Brickcaster/onceagain
...
Added a few notes to classes.xml
2015-11-02 07:38:06 +01:00
Brickcaster
e0e4bcc6a6
Added description to classes/ScrollContainer
...
Added description to help understand how to utilize the ScrollContainer
node.
2015-11-01 20:58:07 -05:00
Brickcaster
18964798b7
classes/color - Documenting a trick with set_modulate
...
I wanted to document a trick using class color to highlight a sprite.
2015-11-01 20:58:06 -05:00
Brickcaster
44057ed4ae
Updated classes/matrix32
...
The 3 members of a matrix 32 are Vector2, not float. Updated
documentation to reflect this.
2015-10-25 19:29:44 -04:00
George Marques
baa59c0670
Add missing reference documentation for Array class
2015-10-20 14:31:30 -02:00
George Marques
eefc2bf5f7
Syncing classes.xml with current binary
2015-10-20 14:26:37 -02:00
Julian Murgia - StraToN
2975064c4d
GraphEdit and GraphNode documentation
2015-10-16 17:56:03 +02:00
George Marques
6e87314d83
Add support for Opus audio format
2015-10-02 14:25:38 -03:00
Rémi Verschelde
7c1a79089a
Update documentation for all Sample* classes
2015-09-26 23:58:12 +02:00
Juan Linietsky
6f0df4e80c
Merge pull request #2534 from eska014/unpress-hidden-buttons
...
Fix BaseButtons remaining pressed when hiding while pressed down
2015-09-26 00:53:38 -03:00
eska
6ee2a84e8a
Clarify `BaseButton::is_pressed()` documentation
2015-09-26 05:48:51 +02:00
Rémi Verschelde
4abc7f5740
Update documentation for TileSet and Timer
2015-09-25 20:45:00 +02:00
Rémi Verschelde
c69ea708fa
Sync classes reference template with current code base
2015-09-25 17:54:24 +02:00
Juan Linietsky
52eebdc001
Merge pull request #2449 from leezh/label-valign-fix
...
reworked Label class
2015-09-25 11:29:49 -03:00
Rémi Verschelde
d55274b5b0
Document TileMap class
2015-09-23 23:05:47 +02:00
Bojidar Marinov
f41ed99df2
Update descriptions for Vector2 and Vector2Array
2015-09-23 17:41:02 +03:00
Bojidar Marinov
6adb5ed440
Regenerate docs
2015-09-23 17:34:07 +03:00
Zher Huei Lee
b33c288525
updated Label documentation
2015-09-08 10:41:58 +01:00
Ovnuniarchos
d1a260c966
A bunch of spell checks, and rewordings. Also, some simple documentation.
2015-07-26 20:09:47 +02:00
Ovnuniarchos
43053e3a71
Added a proper name and an explanation to arg4 on CanvasItem.draw_texture_rect*.
2015-07-20 20:07:25 +02:00
ShadowKyogre
631cb10e86
Add some documentation for RayCast2D about is_colliding and get_collider quirks
2015-06-24 13:24:42 -07:00
krzycho
d65455185a
- added GDscript bidings for UndoRedo class mechanizm
...
- registered UndoRedo
2015-06-21 22:23:09 +02:00
Juan Linietsky
e323cc0505
-Rename unexisting by nonexistant, closes #1940
...
-Added function to retrieve list of actions fron InputMap
2015-05-18 10:20:54 -03:00
Juan Linietsky
af06843982
-new collision layer & mask system for 2D, for more flexible collision masking
2015-05-03 16:47:21 -03:00
Simon Wenner
8156db1623
updated outdated or missing Plane class documentation
2015-04-20 23:31:53 +02:00
Simon Wenner
03fd8a80c1
fixed incorrect constructor descriptions in Matrix3
2015-04-20 22:38:26 +02:00