summaryrefslogtreecommitdiffstats
path: root/doc/classes/ConfigFile.xml
Commit message (Collapse)AuthorAgeFilesLines
* Rebranding: Doc/Dubhghlas McLaughlin2024-10-161-1/+1
|
* Use `[codeblock lang=text]` more often in class refMicky2024-04-081-1/+1
|
* Clarify ConfigFile class methods that return errorcurious-broccoli2023-08-241-7/+7
| | | | related to #80936
* Doctool: Remove version attribute from XML headerRémi Verschelde2023-07-061-1/+1
| | | | | | We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
* Bump version to 4.2-devRémi Verschelde2023-07-051-1/+1
| | | | Keep on waitin'
* Bump version to 4.1-devRémi Verschelde2023-03-011-1/+1
| | | | Can't stop, won't stop, they said, huh?
* Style: Misc docs and comment style and language fixesRémi Verschelde2022-11-021-7/+7
| | | | | | | | | | - 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`.
* Add support for scene/resource customization in export pluginsJuan Linietsky2022-09-011-0/+6
| | | | | | | | | | | | | | | EditorExportPlugin adds a set of callbacks to allow customizing scenes, resources or subresources in all files exported: * Can take scene files, resource files and subresources in all of them. * Uses a cache for the converted files if nothing changes, so this work only happens if a file is modified. * Uses hashing to differentiate export configuration caches. * Removed the previous conversion code to binary, as this one uses existing stuff. This API is useful in several scenarios: * Needed by the "server" export platform to get rid of textures, meshes, audio, etc. * Needed by text to binary converters. * Needed by eventual optimizations such as shader precompiling on export, mesh merging and optimization, etc. This is a draft, feedback is very welcome.
* [doc] Use "param" instead of "code" to refer to parameters (7)Andy Maloney2022-08-121-5/+5
|
* Rename the argument tag to param in XML documentationYuri Sizov2022-08-081-24/+24
|
* Add an XML schema for documentationHugo Locurcio2022-02-151-1/+1
| | | | | | | | 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.
* Don't generate empty doc sections and reduce code duplicationAaron Franke2021-09-201-2/+0
|
* doc: Clarify need to save ConfigFile to apply changes to filegeorgespatton2021-09-141-0/+2
| | | | See #52645 for context.
* Document that ConfigFiles can use any file extensionHugo Locurcio2021-09-111-0/+1
| | | | | The file extension given to a ConfigFile has no impact on its formatting or behavior.
* Implement error return documetationreduz2021-08-241-0/+2
| | | | | | | | | | | | | | 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.
* Merge pull request #50893 from KoBeWi/how_to_config_fileRémi Verschelde2021-08-031-21/+62
|\ | | | | Improve ConfigFile example
| * Improve ConfigFile examplekobewi2021-08-031-21/+62
| |
* | doc: Use self-closing tags for `return` and `argument`Rémi Verschelde2021-07-301-80/+40
|/ | | | | | | | 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.
* Better format arguments in variant parserMichael Alexsander Silva Dias2021-06-181-1/+1
|
* Rename Reference to RefCountedPedro J. Estébanez2021-06-111-1/+1
|
* doc: Sync classref with current sourceRémi Verschelde2021-03-251-0/+6
|
* class reference proofreadingPaul Joannon2021-03-191-1/+1
|
* Translate GDScript Code Examples to C# (C)HaSa10022020-09-261-2/+20
| | | | | | | | | | | | | | | Translates Code Examples in classes beginning with `C`. Includes: * Callable * CanvasItem * CharFXTransform * Color * ColorRect * ConfigFile * ConfirmationDialog * Control * Crypto
* doc: Update classref with node renamesRémi Verschelde2020-03-301-1/+1
| | | | A few extra renames for classes which were missed in last week's PRs.
* ConfigFile: Improve error messages and complete docsRémi Verschelde2020-03-051-8/+17
|
* doc: Sync classref with current sourceRémi Verschelde2020-02-181-4/+4
| | | | Handle removal of Pool*Array types and other recent changes.
* Add ConfigFile::parse()Pedro J. Estébanez2020-02-101-0/+10
|
* Update docs to version 4.0clayjohn2020-01-311-1/+1
|
* doc: Drop unused 'category' property from headerRémi Verschelde2020-01-261-1/+1
| | | | | | | | | | 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.
* doc: Mention the limited comment support in ConfigFileHugo Locurcio2020-01-181-0/+1
|
* doc: Markup fixes for enums and constantsRémi Verschelde2019-12-061-2/+4
|
* doc: Sync classref with current sourceRémi Verschelde2019-10-111-0/+10
|
* doc: Sync classref with current sourceRémi Verschelde2019-06-291-0/+40
|
* Proofread and improve the whole class referenceHugo Locurcio2019-06-271-1/+1
| | | | | | | | | | | | | - 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
* doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde2019-06-271-2/+2
|
* doc: Drop unused <demos> tagRémi Verschelde2019-04-191-2/+0
|
* doc: Bump version to 3.2Rémi Verschelde2019-04-011-1/+1
|
* Document use of spaces in ConfigFileJuan Linietsky2018-11-181-0/+1
|
* Fix mistake in ConfigFile.xmlchar0xff2018-09-151-1/+1
|
* Doc: Fix typos spotted by @yurchorRémi Verschelde2018-07-011-1/+1
|
* doc: Remove status from hardcoded version stringRémi Verschelde2018-02-271-1/+1
| | | | It has no practical use case and just generates noise for each alpha, beta, etc.
* Fix typos with codespellluz.paz2018-02-211-1/+1
| | | | | | | | | | | | | | Found via `codespell -q 3 --skip="./thirdparty,./editor/translations" -I ../godot-word-whitelist.txt` Whitelist consists of: ``` ang doubleclick lod nd que te unselect ```
* doc: Update version string in headerRémi Verschelde2018-02-191-1/+1
|
* doc: Sync with current sourceRémi Verschelde2018-01-251-1/+1
| | | | | | 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).
* doc: Update version string in XMLRémi Verschelde2018-01-131-1/+1
|
* doc: Update header version for 3.0-betaRémi Verschelde2017-11-241-1/+1
|
* doc: Rename "@Global Scope" to "@GlobalScope"Rémi Verschelde2017-11-151-2/+2
| | | | Spaces in filenames are evil.
* doc: Remove revision.module_config from version stringRémi Verschelde2017-11-151-1/+1
| | | | | It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
* Small edits to ConfigFile docs.Benjamin Larsson2017-10-131-12/+19
|
* Changed the doc class generation to individual files per class. It is also ↵Juan Linietsky2017-09-121-0/+119
possible to save module files in module directories and the build system will recognize them.