summaryrefslogtreecommitdiff
path: root/doc/classes/ConfigFile.xml
AgeCommit message (Collapse)Author
2022-08-12[doc] Use "param" instead of "code" to refer to parameters (7)Andy Maloney
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-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-09-14doc: Clarify need to save ConfigFile to apply changes to filegeorgespatton
See #52645 for context.
2021-09-11Document that ConfigFiles can use any file extensionHugo Locurcio
The file extension given to a ConfigFile has no impact on its formatting or behavior.
2021-08-24Implement error return documetationreduz
Adds ability to add error return documetation to the binder and class reference. Usage example: ```C++ void MyClass::_bind_method() { [..] BIND_METHOD_ERR_RETURN_DOC("load", ERR_FILE_CANT_OPEN, ERR_FILE_UNRECOGNIZED); } ``` One function of ConfigFile was changed as example.
2021-08-03Merge pull request #50893 from KoBeWi/how_to_config_fileRémi Verschelde
Improve ConfigFile example
2021-08-03Improve ConfigFile examplekobewi
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-18Better format arguments in variant parserMichael Alexsander Silva Dias
2021-06-11Rename Reference to RefCountedPedro J. Estébanez
2021-03-25doc: Sync classref with current sourceRémi Verschelde
2021-03-19class reference proofreadingPaul Joannon
2020-09-26Translate GDScript Code Examples to C# (C)HaSa1002
Translates Code Examples in classes beginning with `C`. Includes: * Callable * CanvasItem * CharFXTransform * Color * ColorRect * ConfigFile * ConfirmationDialog * Control * Crypto
2020-03-30doc: Update classref with node renamesRémi Verschelde
A few extra renames for classes which were missed in last week's PRs.
2020-03-05ConfigFile: Improve error messages and complete docsRémi Verschelde
2020-02-18doc: Sync classref with current sourceRémi Verschelde
Handle removal of Pool*Array types and other recent changes.
2020-02-10Add ConfigFile::parse()Pedro J. Estébanez
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-18doc: Mention the limited comment support in ConfigFileHugo Locurcio
2019-12-06doc: Markup fixes for enums and constantsRémi Verschelde
2019-10-11doc: Sync classref with current sourceRémi Verschelde
2019-06-29doc: Sync classref with current sourceRémi Verschelde
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-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-11-18Document use of spaces in ConfigFileJuan Linietsky
2018-09-15Fix mistake in ConfigFile.xmlchar0xff
2018-07-01Doc: Fix typos spotted by @yurchorRémi Verschelde
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-21Fix typos with codespellluz.paz
Found via `codespell -q 3 --skip="./thirdparty,./editor/translations" -I ../godot-word-whitelist.txt` Whitelist consists of: ``` ang doubleclick lod nd que te unselect ```
2018-02-19doc: Update version string in headerRé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-13doc: Update version string in XMLRémi Verschelde
2017-11-24doc: Update header version for 3.0-betaRémi Verschelde
2017-11-15doc: Rename "@Global Scope" to "@GlobalScope"Rémi Verschelde
Spaces in filenames are evil.
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-13Small edits to ConfigFile docs.Benjamin Larsson
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.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-17 07:27:22 +0000