Commit Graph

126 Commits

Author SHA1 Message Date
David 00d3c657de applied some typo fixes. see godotengine/godot-docs#18 2016-02-24 01:53:44 -06:00
Josh Grams d2ac38679d doc (NodePath): Rewrite description and all methods. 2016-02-22 17:59:18 -05:00
Josh Grams 47a2213580 docs: RigidBody2D._integrate_forces: Explain in more detail. 2016-02-20 21:18:24 -05:00
Alexander Holland d809987827 update doc on HTTPClient headers case-sensitivity 2016-02-20 00:37:43 +01:00
Rémi Verschelde 0dce4f7eb2 Remove broken [image] usage in classref 2016-02-19 18:39:16 +01:00
Rémi Verschelde 16b0cf8bcb Merge pull request #3754 from akien-mga/pr-subtract
Rename KEY_KP_SUBSTRACT to KEY_KP_SUBTRACT
2016-02-17 23:33:13 +01:00
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