Commit Graph

17 Commits

Author SHA1 Message Date
6e95397180 Update UPnP documentation
Adds more details, especially about caveats, failure modes and pitfalls

(cherry picked from commit be41c09769)
2022-08-29 15:56:43 +02:00
0a8d5d7098 Bump version to 3.6-beta 2022-08-05 18:51:38 +02:00
b087538119 Add an XML schema for documentation
This makes it easier to spot syntax errors when editing the
class reference. The schema is referenced locally so validation
can still work offline.

Each class XML's schema conformance is also checked on GitHub Actions.
2022-03-16 23:01:02 +01:00
14c366ddd7 Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
7e3016ebfd Document how to set up UPnP in a non-blocking manner
(cherry picked from commit f4bebc272c)
2021-10-04 14:37:43 +02: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
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
08cb8420f7 Mention the duration parameter unit in UPNP.add_port_mapping()
(cherry picked from commit 810be27c78)
2020-03-04 12:40:14 +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
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
2a63853720 doc: UPNP: Add example on how to open/close a port
I have added a small code sample to show how to automate the process of port forwarding (and closing after you are done).
Thanks to @mhilbrunner for explaining how to achieve t0his (see #18780)
2019-06-27 17:17:15 +02:00
bc82781f7d doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks 2019-06-27 13:49:36 +02:00
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
08bde5b2de Misc. typos
Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"`
2018-09-12 21:39:17 -04:00
c21da40de5 Add UPnP support (port forwarding, querying external IP) 2018-06-07 01:52:04 +02:00