summaryrefslogtreecommitdiff
path: root/editor/doc
AgeCommit message (Collapse)Author
2019-07-04DocData: Re-expose parametric setters and gettersRémi Verschelde
Setters and getters have been hidden from the documentation when the matching properties have been exposed, but some of them are parametric and require the name or index of a given parameter to be used. So they need to be properly documented with the type and name of the arguments they take. For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-06-29Remove bogus nulls from generated default valuesBojidar Marinov
Also, fix crash in PluginScript destructor.
2019-06-27Add default values to the editor help, docs, and generated RSTBojidar Marinov
Also, make spacing of "=" in the editor help a bit more consistent. Closes #16086
2019-06-25doctool: Fix writing theme_item descriptionsRémi Verschelde
We already had support for parsing and saving theme_item descriptions in DocData, and displaying it in the editor, but doctool would drop the changes as it was not writing them back to the XML. Part of #29868.
2019-06-03doc: Fix DocData.merge_from copying old setters and gettersRémi Verschelde
This is not necessary and means that some setters and getters can end up wrong if they are changed in the bindings but DocData does not update them when running --doctool. Fixes #29425. Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
2019-05-19Fix typos with codespellRémi Verschelde
Using codespell 1.15.0. Method: ``` $ cat > ../godot-word-whitelist.txt << EOF ang curvelinear doubleclick leapyear lod merchantibility nd numer ois ony que seeked synching te uint unselect webp EOF $ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po" $ git diff // undo unwanted changes ```
2019-04-19doc: Sync classref with current sourceRémi Verschelde
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-09Style: Apply new changes from clang-format 8.0Rémi Verschelde
It seems to stay compatible with formatting done by clang-format 6.0 and 7.0, so contributors can keep using those versions for now (they will not undo those changes).
2019-02-20Add -Wshadow=local to warnings and fix reported issues.marxin
Fixes #25316.
2019-01-01Update copyright statements to 2019Rémi Verschelde
Happy new year to the wonderful Godot community!
2018-10-03Fix some warnings raised by MSVC 2017Rémi Verschelde
Disabled signed/unsigned warnings like for GCC/Clang (warning C4018: '>=': signed/unsigned mismatch). Fixes the following MSVC 2017 warnings: ``` core\image.cpp(999): warning C4804: '>': unsafe use of type 'bool' in operation core\io\compression.cpp(178): warning C4334: '<<': result of 32-bit shift implicitly converted to 64 bits (was 64-bit shift intended?) editor\doc\doc_dump.cpp(226): warning C4334: '<<': result of 32-bit shift implicitly converted to 64 bits (was 64-bit shift intended?) scene/resources/material.h(289): warning C4334: '<<': result of 32-bit shift implicitly converted to 64 bits (was 64-bit shift intended?) scene/resources/material.h(298): warning C4334: '<<': result of 32-bit shift implicitly converted to 64 bits (was 64-bit shift intended?) editor\editor_themes.cpp(379): warning C4805: '==': unsafe mix of type 'int' and type 'bool' in operation ```
2018-09-28SCons: Build thirdparty code in own env, disable warningsRémi Verschelde
Also remove unnecessary `Export('env')` in other SCsubs, Export should only be used when exporting *new* objects.
2018-09-12Make core/ includes absolute, remove subfolders from include pathRémi Verschelde
This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-08-31DocData: Fix return type listed as "var" instead of "Variant"Rémi Verschelde
2018-08-31emit more detailed type information for signal parametersKelly Thomas
2018-08-24Make some debug prints verbose-only, remove othersRémi Verschelde
2018-07-31Allow some non-integer built-in constants in gdscriptBernhard Liebl
2018-07-26Reduce unnecessary COW on Vector by make writing explicitHein-Pieter van Braam
This commit makes operator[] on Vector const and adds a write proxy to it. From now on writes to Vectors need to happen through the .write proxy. So for instance: Vector<int> vec; vec.push_back(10); std::cout << vec[0] << std::endl; vec.write[0] = 20; Failing to use the .write proxy will cause a compilation error. In addition COWable datatypes can now embed a CowData pointer to their data. This means that String, CharString, and VMap no longer use or derive from Vector. _ALWAYS_INLINE_ and _FORCE_INLINE_ are now equivalent for debug and non-debug builds. This is a lot faster for Vector in the editor and while running tests. The reason why this difference used to exist is because force-inlined methods used to give a bad debugging experience. After extensive testing with modern compilers this is no longer the case.
2018-06-13Style fixes for commit d5bb6faaRémi Verschelde
2018-06-13Merge pull request #19526 from robojumper/fix_tutorialsRémi Verschelde
Add support for tutorial links to makerst.py
2018-06-12Add support for tutorial links to makerst.pyrobojumper
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-11-Make sure that ProjectSettings are properly dumped when dumping docs.Juan Linietsky
-Documented all properties of project settings Update documentation for ProjectSettings
2018-05-11Fix crash on editor startup when running with platform=serverJosh Faust
2018-02-23Refactor version macros and fix related bugsRémi Verschelde
The previous logic with VERSION_MKSTRING was a bit unwieldy, so there were several places hardcoding their own variant of the version string, potentially with bugs (e.g. forgetting the patch number when defined). The new logic defines: - VERSION_BRANCH, the main 'major.minor' version (e.g. 3.1) - VERSION_NUMBER, which can be 'major.minor' or 'major.minor.patch', depending on whether the latter is defined (e.g. 3.1.4) - VERSION_FULL_CONFIG, which contains the version status (e.g. stable) and the module-specific suffix (e.g. mono) - VERSION_FULL_BUILD, same as above but with build/reference name (e.g. official, custom_build, mageia, etc.) Note: Slight change here, as the previous format had the build name *before* the module-specific suffix; now it's after - VERSION_FULL_NAME, same as before, so VERSION_FULL_BUILD prefixed with "Godot v" for readability Bugs fixed thanks to that: - Export templates version matching now properly takes VERSION_PATCH into account by relying on VERSION_FULL_CONFIG. - ClassDB hash no longer takes the build name into account, but limits itself to VERSION_FULL_CONFIG (build name is cosmetic, not relevant for the API hash). - Docs XML no longer hardcode the VERSION_STATUS, this was annoying. - Small cleanup in Windows .rc file thanks to new macros.
2018-01-30Show default values in docs for GDScript built-in functionsGeorge Marques
2018-01-05Add missing copyright headers and fix formattingRémi Verschelde
Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-01Update copyright statements to 2018Rémi Verschelde
Happy new year to the wonderful Godot community!
2017-12-06Created internal usage flag to remove non editor properties from doc, closes ↵Juan Linietsky
#13334
2017-11-25Made Vector::ptrw explicit for writing, compiler was sometimes using the ↵Juan Linietsky
wrong function, leading to unnecesary copy on writes and reduced performance.
2017-11-24Fixes bug where enumeration is not being savedJuan Linietsky
2017-11-24Fix block where setter/getters are cached to be skippedJuan Linietsky
2017-11-24Attempt to remove setters/getters from doc dataJuan Linietsky
2017-11-20Pass engine name and version parts as proper stringsRémi Verschelde
Removes the need for _MKSTR all over the place which has the drawback of converting _MKSTR(UNKNOWN_DEFINE) to "UKNOWN_DEFINE" instead of throwing a compilation error.
2017-11-17Rename Rect3 to AABB.Ferenc Arn
Fixes #12973.
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-11-14Move singleton management from ProjectSettings to EngineLeon Krause
2017-11-12Moved doc description formatting. Fixes #12798Zher Huei Lee
Paragraph spacing is now applied only during rendering (so doctool preserves formatting). Paragraph spacing now no longer applies within [code] tags. Extra bbcode is now ignored within [code] tags.
2017-11-01Added String::dedent() to remove text indentationZher Huei Lee
This functions similarly to Python's textwrap.dedent() It's also been applied to doc_data.cpp to remove extra whitespace while parsing the XML.
2017-09-16DocData: Fix enums for proxy classesIgnacio Etcheverry
2017-09-12DocData: Drop unused brief description for propertiesRémi Verschelde
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.
2017-09-02DocData: Include enum attributes in return nodesIgnacio Etcheverry
2017-08-29Makes built-in vararg methods actual vararg methodsIgnacio Etcheverry
- Removes hardcoded parameters from built-in vararg methods and adds METHOD_FLAG_VARARG to them. - Makes EditorHelp display built-in vararg methods correctly.
2017-08-29DocData and type hints fixesIgnacio Etcheverry
- Makes vararg methods automatically use PROPERTY_USAGE_NIL_IS_VARIANT on return types - Completely removes the ":type" suffix for method names. Virtual methods must use the MethodInfo constructors that takes Variant::Type or PropertyHint as the first parameter for the return type (with CLASS_INFO as a helper to get the PropertyInfo). Parameters must use PROPERTY_HINT_RESOURCE_TYPE and hint string. - PROPERTY_USAGE_NIL_IS_VARIANT is no longer needed for parameters, because parameters cannot be void. - Adds missing PROPERTY_USAGE_NIL_IS_VARIANT to virtual and built-in methods that return Variant.
2017-08-27Use HTTPS URL for Godot's website in the headersRémi Verschelde
2017-08-25DocData: Fix extraneous space in XML tag without enum hintRémi Verschelde
2017-08-23Changed MethodBind API to request information from methods. It's much claner ↵Juan Linietsky
now. Also changed PropertyInfo to include informatino about class names.
2017-07-30Style: Apply clang-format on all filesRémi Verschelde
Thus fixing some invalid changes that had still made it to the master branch.