summaryrefslogtreecommitdiffstats
path: root/editor/doc_tools.cpp
Commit message (Collapse)AuthorAgeFilesLines
* GDScript: Fix issues with typed arraysDmitrii Maganov2023-01-311-9/+6
|
* Merge pull request #71649 from raulsntos/array-indexerRémi Verschelde2023-01-191-0/+1
|\ | | | | | | Add property usage to array indexer
| * Add property usage to array indexerRaul Santos2023-01-191-0/+1
| | | | | | | | This makes the `Array` indexer show as returning `Variant` instead of `void` in the documentation.
* | [GDExtension] Expose some low level functions and String operators.bruvzg2023-01-191-31/+31
|/
* Use BitField<> in core type masksJuan Linietsky2023-01-081-0/+1
| | | | | | | | * All core types masks are now correctly marked as bitfields. * The enum hacks in MouseButtonMask and many other types are gone. This ensures that binders to other languages non C++ can actually implement type safe bitmasks. * Most bitmask operations replaced by functions in BitField<> * Key is still a problem because its enum and mask at the same time. While it kind of works in C++, this most likely can't be implemented safely in other languages and will have to be changed at some point. Mostly left as-is. * Documentation and API dump updated to reflect bitfields in core types.
* One Copyright Update to rule them allRémi Verschelde2023-01-051-29/+29
| | | | | | | | | | | | | | | | | | | | As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
* Unify String and StringNamerune-scape2022-12-051-2/+2
|
* Fix default values on virtual classes causing errors in projectsAaron Franke2022-11-091-1/+1
|
* Fix default values not showing up on virtual classesAaron Franke2022-11-061-1/+1
|
* 2D and 3D Skeleton modification docs, and small fixes.Lyuma2022-09-141-16/+12
| | | | | | | Mark SkeletonModificationStack3D and related as deprecated. Mark local bone override and axis functions deprecated in Skeleton3D api. Fix array property glitch in SkeletonModificationStack2D Mark SkeletonModificationStack2D and related APIs as experimental. Mark SkeletonIK3D as deprecated.
* Add ability to flag classes as experimental or deprecated.SaracenOne2022-09-111-6/+82
|
* Rename String `plus_file` to `path_join`Aaron Franke2022-08-291-2/+2
|
* Add ThemeDB, expose previously static Theme methodsYuri Sizov2022-08-261-8/+9
|
* Rename the argument tag to param in XML documentationYuri Sizov2022-08-081-3/+3
|
* Add tests for empty/unnamed arguments to ClassDB, Variant, GDScriptYuri Sizov2022-08-081-250/+259
|
* Add support for documenting most editor settings in the class referenceHugo Locurcio2022-07-291-4/+17
| | | | | | | | 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>
* Fix missing method qualifiers in script docXwdit2022-07-241-47/+1
| | | | Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
* Merge pull request #62713 from YuriSizov/docs-scripting-annotationsRémi Verschelde2022-07-061-1/+53
|\
| * Add support for documenting built-in annotationsYuri Sizov2022-07-041-1/+53
| |
* | Implement a BitField hintreduz2022-07-051-2/+10
|/ | | | Allows to specify the binder that an enum must be treated as a bitfield.
* Add a new HashSet templatereduz2022-05-201-1/+1
| | | | | * Intended to replace RBSet in most cases. * Optimized for iteration speed
* Replace most uses of Map by HashMapreduz2022-05-161-2/+2
| | | | | | | | | | | | * 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!
* Make FileAccess and DirAccess classes reference counted.bruvzg2022-04-111-7/+7
|
* Remove generating of null comparison operators from documentationYuri Roubinsky2022-03-141-0/+5
|
* Fix decompression functions not returning errcodesRicardo Subtil2022-02-181-1/+2
|
* Translate link titles in classref XMLHaoyu Qiu2022-02-171-1/+1
|
* Add an XML schema for documentationHugo Locurcio2022-02-151-1/+6
| | | | | | | | 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.
* Vectors: Use clear() and has().Anilforextra2022-02-021-2/+2
| | | | | | Use clear() instead of resize(0). Use has() instead of "find(p_val) != -1".
* Merge pull request #56920 from pycbouh/docs-sort-class-propertiesRémi Verschelde2022-01-181-2/+5
|\
| * Sort class properties in the built-in docsYuri Sizov2022-01-191-2/+5
| |
* | Dictionary: Serialize empty dict as `{}` instead of `{\n}`Rémi Verschelde2022-01-181-7/+7
|/ | | | | Also make sure to always convert multiline dictionaries to a single line for its EditorHelp representation, as multiline values break formatting.
* Update copyright statements to 2022Rémi Verschelde2022-01-031-2/+2
| | | | Happy new year to the wonderful Godot community!
* Make `--doctool` locale awareHaoyu Qiu2021-12-161-6/+36
| | | | | | | | | | | | | | | | * 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`.
* Replace String comparisons with "", String() to is_empty()Nathan Franke2021-12-091-25/+25
| | | | | | Also: - Adds two stress tests to test_string.h - Changes to .empty() on std::strings
* Make overridden properties link to parent definitionYuri Sizov2021-12-031-3/+9
| | | | Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
* Sort and group theme properties in docs, improve formatting for theme and enumsYuri Sizov2021-12-011-0/+2
|
* Modules: Make sure to include modules_enabled.gen.h where neededRémi Verschelde2021-11-121-1/+1
|
* Move the docs for constructors and operators out of methods sectionAaron Franke2021-10-291-21/+90
|
* Use range iterators for `Map`Lightning_A2021-09-301-7/+7
|
* Don't generate empty doc sections and reduce code duplicationAaron Franke2021-09-201-91/+76
|
* Implement properties arrays in the Inspector.Gilles Roudière2021-09-071-1/+1
|
* Implement error return documetationreduz2021-08-241-0/+20
| | | | | | | | | | | | | | 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.
* Fix doctool merges when method signatures don't matchreduz2021-08-221-25/+32
| | | | | | | | | | 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).
* Remove underscore hacksMax Hilbrunner2021-08-171-6/+0
| | | | | | Way less cruft. :) Co-authored-by: Ignacio Roldán Etcheverry <neikeq@users.noreply.github.com>
* Add theme item descriptions to the online documentationYuri Sizov2021-08-041-43/+54
|
* doc: Use self-closing tags for `return` and `argument`Rémi Verschelde2021-07-301-8/+4
| | | | | | | | 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.
* Use const references where possible for List range iteratorsRémi Verschelde2021-07-251-16/+16
|
* Use C++ iterators for Lists in many situationsAaron Franke2021-07-231-71/+67
|
* Rename `instance()`->`instantiate()` when it's a verbLightning_A2021-06-191-3/+3
|
* Core: Move DirAccess and FileAccess to `core/io`Rémi Verschelde2021-06-111-1/+1
| | | | | File handling APIs are typically considered part of I/O, and we did have most `FileAccess` implementations in `core/io` already.