summaryrefslogtreecommitdiff
path: root/modules/upnp/doc_classes
AgeCommit message (Collapse)Author
2022-11-02Style: Misc docs and comment style and language fixesRémi Verschelde
- Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
2022-10-24Fix Thread usage in UPNP docs.TechnoPorg
The threading API has changed between Godot 3 and Godot 4. See https://github.com/godotengine/godot-proposals/issues/4691.
2022-08-28Update UPnP documentationMax Hilbrunner
Adds more details, especially about caveats, failure modes and pitfalls
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-02-15Add an XML schema for documentationHugo Locurcio
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.
2021-09-30Document how to set up UPnP in a non-blocking mannerHugo Locurcio
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
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.
2021-06-11Rename Reference to RefCountedPedro J. Estébanez
2020-02-27Mention the `duration` parameter unit in `UPNP.add_port_mapping()`Hugo Locurcio
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
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.
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-27doc: UPNP: Add example on how to open/close a porttree786
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-27doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2018-09-12Misc. typosluz.paz
Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"`
2018-06-07Add UPnP support (port forwarding, querying external IP)mhilbrunner