Commit graph

76 commits

Author SHA1 Message Date
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