godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-04 12:00:25 +00:00
Code Releases Wiki Activity

Documentation: Add support for deprecated/experimental messages

Browse Source
This commit is contained in:
Danil Alexeev
2024-02-12 16:55:02 +03:00
parent 907db8eebc
commit af28f87791
75 changed files with 1165 additions and 738 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
core/doc_data.h
View File

@@ -114,7 +114,9 @@ public:
String qualifiers;
String description;
bool is_deprecated = false;
String deprecated_message;
bool is_experimental = false;
String experimental_message;
Vector<ArgumentDoc> arguments;
Vector<int> errors_returned;
String keywords;
@@ -172,6 +174,7 @@ public:
doc.description = p_dict["description"];
}
#ifndef DISABLE_DEPRECATED
if (p_dict.has("is_deprecated")) {
doc.is_deprecated = p_dict["is_deprecated"];
}
@@ -179,6 +182,17 @@ public:
if (p_dict.has("is_experimental")) {
doc.is_experimental = p_dict["is_experimental"];
}
#endif
if (p_dict.has("deprecated")) {
doc.is_deprecated = true;
doc.deprecated_message = p_dict["deprecated"];
}
if (p_dict.has("experimental")) {
doc.is_experimental = true;
doc.experimental_message = p_dict["experimental"];
}
Array arguments;
if (p_dict.has("arguments")) {
@@ -226,9 +240,13 @@ public:
dict["description"] = p_doc.description;
}
dict["is_deprecated"] = p_doc.is_deprecated;
if (p_doc.is_deprecated) {
dict["deprecated"] = p_doc.deprecated_message;
}
dict["is_experimental"] = p_doc.is_experimental;
if (p_doc.is_experimental) {
dict["experimental"] = p_doc.experimental_message;
}
if (!p_doc.keywords.is_empty()) {
dict["keywords"] = p_doc.keywords;
@@ -262,7 +280,9 @@ public:
bool is_bitfield = false;
String description;
bool is_deprecated = false;
String deprecated_message;
bool is_experimental = false;
String experimental_message;
String keywords;
bool operator<(const ConstantDoc &p_const) const {
return name < p_const.name;
@@ -293,6 +313,7 @@ public:
doc.description = p_dict["description"];
}
#ifndef DISABLE_DEPRECATED
if (p_dict.has("is_deprecated")) {
doc.is_deprecated = p_dict["is_deprecated"];
}
@@ -300,6 +321,17 @@ public:
if (p_dict.has("is_experimental")) {
doc.is_experimental = p_dict["is_experimental"];
}
#endif
if (p_dict.has("deprecated")) {
doc.is_deprecated = true;
doc.deprecated_message = p_dict["deprecated"];
}
if (p_dict.has("experimental")) {
doc.is_experimental = true;
doc.experimental_message = p_dict["experimental"];
}
if (p_dict.has("keywords")) {
doc.keywords = p_dict["keywords"];
@@ -329,9 +361,13 @@ public:
dict["description"] = p_doc.description;
}
dict["is_deprecated"] = p_doc.is_deprecated;
if (p_doc.is_deprecated) {
dict["deprecated"] = p_doc.deprecated_message;
}
dict["is_experimental"] = p_doc.is_experimental;
if (p_doc.is_experimental) {
dict["experimental"] = p_doc.experimental_message;
}
if (!p_doc.keywords.is_empty()) {
dict["keywords"] = p_doc.keywords;
@@ -352,7 +388,9 @@ public:
bool overridden = false;
String overrides;
bool is_deprecated = false;
String deprecated_message;
bool is_experimental = false;
String experimental_message;
String keywords;
bool operator<(const PropertyDoc &p_prop) const {
return name.naturalcasecmp_to(p_prop.name) < 0;
@@ -399,6 +437,7 @@ public:
doc.overrides = p_dict["overrides"];
}
#ifndef DISABLE_DEPRECATED
if (p_dict.has("is_deprecated")) {
doc.is_deprecated = p_dict["is_deprecated"];
}
@@ -406,6 +445,17 @@ public:
if (p_dict.has("is_experimental")) {
doc.is_experimental = p_dict["is_experimental"];
}
#endif
if (p_dict.has("deprecated")) {
doc.is_deprecated = true;
doc.deprecated_message = p_dict["deprecated"];
}
if (p_dict.has("experimental")) {
doc.is_experimental = true;
doc.experimental_message = p_dict["experimental"];
}
if (p_dict.has("keywords")) {
doc.keywords = p_dict["keywords"];
@@ -451,9 +501,13 @@ public:
dict["overrides"] = p_doc.overrides;
}
dict["is_deprecated"] = p_doc.is_deprecated;
if (p_doc.is_deprecated) {
dict["deprecated"] = p_doc.deprecated_message;
}
dict["is_experimental"] = p_doc.is_experimental;
if (p_doc.is_experimental) {
dict["experimental"] = p_doc.experimental_message;
}
if (!p_doc.keywords.is_empty()) {
dict["keywords"] = p_doc.keywords;
@@ -571,7 +625,9 @@ public:
struct EnumDoc {
String description;
bool is_deprecated = false;
String deprecated_message;
bool is_experimental = false;
String experimental_message;
static EnumDoc from_dict(const Dictionary &p_dict) {
EnumDoc doc;
@@ -579,6 +635,7 @@ public:
doc.description = p_dict["description"];
}
#ifndef DISABLE_DEPRECATED
if (p_dict.has("is_deprecated")) {
doc.is_deprecated = p_dict["is_deprecated"];
}
@@ -586,6 +643,17 @@ public:
if (p_dict.has("is_experimental")) {
doc.is_experimental = p_dict["is_experimental"];
}
#endif
if (p_dict.has("deprecated")) {
doc.is_deprecated = true;
doc.deprecated_message = p_dict["deprecated"];
}
if (p_dict.has("experimental")) {
doc.is_experimental = true;
doc.experimental_message = p_dict["experimental"];
}
return doc;
}
@@ -596,9 +664,13 @@ public:
dict["description"] = p_doc.description;
}
dict["is_deprecated"] = p_doc.is_deprecated;
if (p_doc.is_deprecated) {
dict["deprecated"] = p_doc.deprecated_message;
}
dict["is_experimental"] = p_doc.is_experimental;
if (p_doc.is_experimental) {
dict["experimental"] = p_doc.experimental_message;
}
return dict;
}
@@ -621,7 +693,9 @@ public:
Vector<MethodDoc> annotations;
Vector<ThemeItemDoc> theme_properties;
bool is_deprecated = false;
String deprecated_message;
bool is_experimental = false;
String experimental_message;
bool is_script_doc = false;
String script_path;
bool operator<(const ClassDoc &p_class) const {
@@ -730,6 +804,7 @@ public:
doc.theme_properties.push_back(ThemeItemDoc::from_dict(theme_properties[i]));
}
#ifndef DISABLE_DEPRECATED
if (p_dict.has("is_deprecated")) {
doc.is_deprecated = p_dict["is_deprecated"];
}
@@ -737,6 +812,17 @@ public:
if (p_dict.has("is_experimental")) {
doc.is_experimental = p_dict["is_experimental"];
}
#endif
if (p_dict.has("deprecated")) {
doc.is_deprecated = true;
doc.deprecated_message = p_dict["deprecated"];
}
if (p_dict.has("experimental")) {
doc.is_experimental = true;
doc.experimental_message = p_dict["experimental"];
}
if (p_dict.has("is_script_doc")) {
doc.is_script_doc = p_dict["is_script_doc"];
@@ -847,9 +933,13 @@ public:
dict["theme_properties"] = theme_properties;
}
dict["is_deprecated"] = p_doc.is_deprecated;
if (p_doc.is_deprecated) {
dict["deprecated"] = p_doc.deprecated_message;
}
dict["is_experimental"] = p_doc.is_experimental;
if (p_doc.is_experimental) {
dict["experimental"] = p_doc.experimental_message;
}
dict["is_script_doc"] = p_doc.is_script_doc;