godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

DocData: Skip unexposed classes 

Properly expose classes that we actually want accessible.

(cherry picked from commit 0ef8bcac4d)
This commit is contained in:
Rémi Verschelde 2020-04-20 12:29:34 +02:00
parent 982dee67f0
commit 253fc093b8
14 changed files with 11 additions and 135 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
core/crypto/crypto.h
View File

@ -84,8 +84,6 @@ public:
};
class ResourceFormatLoaderCrypto : public ResourceFormatLoader {
GDCLASS(ResourceFormatLoaderCrypto, ResourceFormatLoader);
public:
virtual RES load(const String &p_path, const String &p_original_path = "", Error *r_error = NULL);
virtual void get_recognized_extensions(List<String> *p_extensions) const;
@ -94,8 +92,6 @@ public:
};
class ResourceFormatSaverCrypto : public ResourceFormatSaver {
GDCLASS(ResourceFormatSaverCrypto, ResourceFormatSaver);
public:
virtual Error save(const String &p_path, const RES &p_resource, uint32_t p_flags = 0);
virtual void get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const;

2
doc/classes/DynamicFont.xml
View File

@ -12,7 +12,7 @@
dynamic_font.size = 64
$"Label".set("custom_fonts/font", dynamic_font)
[/codeblock]
[b]Note:[/b] DynamicFont doesn't support features such as right-to-left typesetting, ligatures, text shaping, variable fonts and optional font features yet. If you wish to "bake" an optional font feature into a TTF font file, you can use [url=https://fontforge.org/]FontForge[/url] to do so. In FontForge, use [b]File > Generate Fonts[/b], click [b]Options[/b], choose the desired features then generate the font.
[b]Note:[/b] DynamicFont doesn't support features such as right-to-left typesetting, ligatures, text shaping, variable fonts and optional font features yet. If you wish to "bake" an optional font feature into a TTF font file, you can use [url=https://fontforge.org/]FontForge[/url] to do so. In FontForge, use [b]File &gt; Generate Fonts[/b], click [b]Options[/b], choose the desired features then generate the font.
</description>
<tutorials>
</tutorials>

15
doc/classes/IP_Unix.xml
View File

@ -1,15 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="IP_Unix" inherits="IP" version="3.2">
<brief_description>
UNIX IP support. See [IP].
</brief_description>
<description>
UNIX-specific implementation of IP support functions. See [IP].
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

15
doc/classes/InputDefault.xml
View File

@ -1,15 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="InputDefault" inherits="Input" version="3.2">
<brief_description>
Default implementation of the [Input] class.
</brief_description>
<description>
Default implementation of the [Input] class, used internally by the editor and games for default input management.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

15
doc/classes/Physics2DDirectBodyStateSW.xml
View File

@ -1,15 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Physics2DDirectBodyStateSW" inherits="Physics2DDirectBodyState" version="3.2">
<brief_description>
Software implementation of [Physics2DDirectBodyState].
</brief_description>
<description>
Software implementation of [Physics2DDirectBodyState]. This object exposes no new methods or properties and should not be used, as [Physics2DDirectBodyState] selects the best implementation available.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

15
doc/classes/Physics2DServerSW.xml
View File

@ -1,15 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Physics2DServerSW" inherits="Physics2DServer" version="3.2">
<brief_description>
Software implementation of [Physics2DServer].
</brief_description>
<description>
This class exposes no new methods or properties and should not be used, as [Physics2DServer] automatically selects the best implementation available.
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

13
doc/classes/ResourceFormatLoaderCrypto.xml
View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceFormatLoaderCrypto" inherits="ResourceFormatLoader" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

13
doc/classes/ResourceFormatSaverCrypto.xml
View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="ResourceFormatSaverCrypto" inherits="ResourceFormatSaver" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

6
editor/doc/doc_data.cpp
View File

@ -243,6 +243,12 @@ void DocData::generate(bool p_basic_types) {
Set<StringName> setters_getters;
String name = classes.front()->get();
if (!ClassDB::is_class_exposed(name)) {
print_verbose(vformat("Class '%s' is not exposed, skipping.", name));
classes.pop_front();
continue;
}
String cname = name;
if (cname.begins_with("_")) //proxy class
cname = cname.substr(1, name.length());

6
main/main.cpp
View File

@ -1131,9 +1131,11 @@ Error Main::setup(const char *execpath, int argc, char *argv[], bool p_second_ph
ProjectSettings::get_singleton()->set_custom_property_info("debug/settings/fps/force_fps", PropertyInfo(Variant::INT, "debug/settings/fps/force_fps", PROPERTY_HINT_RANGE, "0,120,1,or_greater"));
GLOBAL_DEF("debug/settings/stdout/print_fps", false);
GLOBAL_DEF("debug/settings/stdout/verbose_stdout", false);
if (!OS::get_singleton()->_verbose_stdout) //overridden
OS::get_singleton()->_verbose_stdout = GLOBAL_DEF("debug/settings/stdout/verbose_stdout", false);
if (!OS::get_singleton()->_verbose_stdout) { // Not manually overridden.
OS::get_singleton()->_verbose_stdout = GLOBAL_GET("debug/settings/stdout/verbose_stdout");
}
if (frame_delay == 0) {
frame_delay = GLOBAL_DEF("application/run/frame_delay_msec", 0);

9
modules/bullet/config.py
View File

@ -3,12 +3,3 @@ def can_build(env, platform):
def configure(env):
pass
def get_doc_classes():
return [
"BulletPhysicsDirectBodyState",
"BulletPhysicsServer",
]
def get_doc_path():
return "doc_classes"

13
modules/bullet/doc_classes/BulletPhysicsDirectBodyState.xml
View File

@ -1,13 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BulletPhysicsDirectBodyState" inherits="PhysicsDirectBodyState" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<constants>
</constants>
</class>

1
modules/gdscript/config.py
View File

@ -9,7 +9,6 @@ def get_doc_classes():
"@GDScript",
"GDScript",
"GDScriptFunctionState",
"GDScriptNativeClass",
]
def get_doc_path():

19
modules/gdscript/doc_classes/GDScriptNativeClass.xml
View File

@ -1,19 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="GDScriptNativeClass" inherits="Reference" version="3.2">
<brief_description>
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="new">
<return type="Variant">
</return>
<description>
</description>
</method>
</methods>
<constants>
</constants>
</class>