summaryrefslogtreecommitdiff
path: root/editor/doc_tools.cpp
AgeCommit message (Collapse)Author
2022-07-29Add support for documenting most editor settings in the class referenceHugo Locurcio
Settings defined in editor plugins are missing (about 100 of them), but all other settings (about 200 of them) can now be documented in the EditorSettings class. Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2022-07-24Fix missing method qualifiers in script docXwdit
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2022-07-06Merge pull request #62713 from YuriSizov/docs-scripting-annotationsRémi Verschelde
2022-07-05Implement a BitField hintreduz
Allows to specify the binder that an enum must be treated as a bitfield.
2022-07-04Add support for documenting built-in annotationsYuri Sizov
2022-05-20Add a new HashSet templatereduz
* Intended to replace RBSet in most cases. * Optimized for iteration speed
2022-05-16Replace most uses of Map by HashMapreduz
* Map is unnecessary and inefficient in almost every case. * Replaced by the new HashMap. * Renamed Map to RBMap and Set to RBSet for cases that still make sense (order matters) but use is discouraged. There were very few cases where replacing by HashMap was undesired because keeping the key order was intended. I tried to keep those (as RBMap) as much as possible, but might have missed some. Review appreciated!
2022-04-11Make FileAccess and DirAccess classes reference counted.bruvzg
2022-03-14Remove generating of null comparison operators from documentationYuri Roubinsky
2022-02-18Fix decompression functions not returning errcodesRicardo Subtil
2022-02-17Translate link titles in classref XMLHaoyu Qiu
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.
2022-02-02Vectors: Use clear() and has().Anilforextra
Use clear() instead of resize(0). Use has() instead of "find(p_val) != -1".
2022-01-18Merge pull request #56920 from pycbouh/docs-sort-class-propertiesRémi Verschelde
2022-01-19Sort class properties in the built-in docsYuri Sizov
2022-01-18Dictionary: Serialize empty dict as `{}` instead of `{\n}`Rémi Verschelde
Also make sure to always convert multiline dictionaries to a single line for its EditorHelp representation, as multiline values break formatting.
2022-01-03Update copyright statements to 2022Rémi Verschelde
Happy new year to the wonderful Godot community!
2021-12-16Make `--doctool` locale awareHaoyu Qiu
* Adds `indent(str)` to `String`: * Indent the (multiline) string with the given indentation. * This method is added in order to keep the translated XML correctly indented. * Moves the loading of tool/doc translation into `editor/editor_translation.{h,cpp}`. * This will be used from both `EditorSettings` and the doc tool from `main`. * Makes use of doc translation when generating XML class references, and setup the translation locale based on `-l LOCALE` CLI parameter. The XML class reference won't be translated if `-l LOCALE` parameter is not given, or when it's `-l en`.
2021-12-09Replace String comparisons with "", String() to is_empty()Nathan Franke
Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
2021-12-03Make overridden properties link to parent definitionYuri Sizov
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-01Sort and group theme properties in docs, improve formatting for theme and enumsYuri Sizov
2021-11-12Modules: Make sure to include modules_enabled.gen.h where neededRémi Verschelde
2021-10-29Move the docs for constructors and operators out of methods sectionAaron Franke
2021-09-30Use range iterators for `Map`Lightning_A
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-09-07Implement properties arrays in the Inspector.Gilles Roudière
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-22Fix doctool merges when method signatures don't matchreduz
If methods signature did not match, documentation is not merged. This is a considerable source of annoyance for contributors and it happened as a result of #4533, otherwise the documentation for constructors would not be properly merged. This PR modifies the logic introduced to only do the signature test on constructors and operators (which are the only types of members that can repeat).
2021-08-17Remove underscore hacksMax Hilbrunner
Way less cruft. :) Co-authored-by: Ignacio Roldán Etcheverry <neikeq@users.noreply.github.com>
2021-08-04Add theme item descriptions to the online documentationYuri Sizov
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-07-25Use const references where possible for List range iteratorsRémi Verschelde
2021-07-23Use C++ iterators for Lists in many situationsAaron Franke
2021-06-19Rename `instance()`->`instantiate()` when it's a verbLightning_A
2021-06-11Core: Move DirAccess and FileAccess to `core/io`Rémi Verschelde
File handling APIs are typically considered part of I/O, and we did have most `FileAccess` implementations in `core/io` already.
2021-03-16Add static method support to core Variant typesreduz
* Properly exposed, including validated and variant call * Bound static functions in String and Color * Did not add support for scripting languages, will have to be added manually.
2021-01-01Update copyright statements to 2021Rémi Verschelde
Happy new year to the wonderful Godot community! 2020 has been a tough year for most of us personally, but a good year for Godot development nonetheless with a huge amount of work done towards Godot 4.0 and great improvements backported to the long-lived 3.2 branch. We've had close to 400 contributors to engine code this year, authoring near 7,000 commit! (And that's only for the `master` branch and for the engine code, there's a lot more when counting docs, demos and other first-party repos.) Here's to a great year 2021 for all Godot users 🎆
2020-12-28Rename empty() to is_empty()Marcel Admiraal
2020-12-02Refactor DocData into core and editor (DocTools) partsThakee Nathees
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-23 07:48:24 +0000