summaryrefslogtreecommitdiff
path: root/doc/classes/StreamPeerSSL.xml
AgeCommit message (Collapse)Author
2022-08-09[doc] Use "param" instead of "code" to refer to parameters #3Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-05-25Add StreamPeerSSL.get_stream() accessor.Lyuma
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-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-09-25Document Android permission requirements for network access where neededHugo 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.
2020-08-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-03-13Add LOTS of missing docsTomasz Chabora
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.
2020-01-14Update documentation to reflect HTML5 limitations.Fabio Alessandrelli
2019-09-24Add documentation for crypto-related classes.Fabio Alessandrelli
Add documentation for Crypto, CryptoKey, HashingContext, and X509Certificate. Add documentation for `StreamPeerSSL.accept_peer`. Ref #29871.
2019-08-22doc: Sync classref with current sourceRémi Verschelde
Fix wrong hyperlinks in Control and Tree.
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-05-23Change "Return" to "Returns" where necessary in XML documentationSean Heffernan
In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-04-22Merge pull request #28125 from KoBeWi/code_true_codeRémi Verschelde
Consistently wrap booleans in [code]
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-17Consistently wrap booleans in [code]Tomasz Chabora
2019-04-05Merge pull request #27465 from ↵Rémi Verschelde
neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2019-03-29ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]Ignacio Etcheverry
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2018-11-05doc: Use HTTPS for docs.godotengine.org and point to latest branchRémi Verschelde
Fixes #23509.
2018-10-07Update class documentation xmlKelly Thomas
2018-07-26doc: Sync classref with current sourceRémi Verschelde
Fix various missing arguments in bindings.
2018-06-12Add support for tutorial links to makerst.pyrobojumper
Also change the <tutorials> structure to make use of individual <link> tags
2018-02-27doc: Remove status from hardcoded version stringRémi Verschelde
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-19doc: Update version string in headerRémi Verschelde
2018-02-14Add mbedtls moduleFabio Alessandrelli
2018-01-25doc: Fix references to online tutorials after godotengine/godot-docs#1015Rémi Verschelde
2018-01-25doc: Sync with current sourceRémi Verschelde
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
2018-01-17doc: Replace some more "val" with "value" + syncRémi Verschelde
2018-01-15Filled tutorial field in most relevent classes.Juan Linietsky
Added tutorial display in doc.
2018-01-13doc: Update version string in XMLRémi Verschelde
2017-11-24doc: Fix enum tags thanks to 2bc6db6Rémi Verschelde
2017-11-24doc: Update header version for 3.0-betaRémi Verschelde
2017-11-15doc: Remove revision.module_config from version stringRémi Verschelde
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
2017-10-22classref: Sync with current sourceRémi Verschelde
Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-09-12Changed the doc class generation to individual files per class. It is also ↵Juan Linietsky
possible to save module files in module directories and the build system will recognize them.