Browse Source

Add keywords to the class reference

Allows for finding methods, properties, signals, constants,
theme items and annotations more easily.

- Allow "keywords" attribute in aforementioned locations
  in the class reference XMLs
- Extends doctool, to preserve these attributes
- Update the XSD schema for the class reference
- Update the RST generator to include a meta tag for class keywords
- Update the editor help to support filtering by keywords
RedMser 2 years ago
parent
commit
db798b29b2
6 changed files with 162 additions and 28 deletions
  1. 45 0
      core/doc_data.h
  2. 7 0
      doc/class.xsd
  3. 9 0
      doc/tools/make_rst.py
  4. 45 8
      editor/doc_tools.cpp
  5. 51 17
      editor/editor_help_search.cpp
  6. 5 3
      editor/editor_help_search.h

+ 45 - 0
core/doc_data.h

@@ -117,6 +117,7 @@ public:
 		bool is_experimental = false;
 		bool is_experimental = false;
 		Vector<ArgumentDoc> arguments;
 		Vector<ArgumentDoc> arguments;
 		Vector<int> errors_returned;
 		Vector<int> errors_returned;
+		String keywords;
 		bool operator<(const MethodDoc &p_method) const {
 		bool operator<(const MethodDoc &p_method) const {
 			if (name == p_method.name) {
 			if (name == p_method.name) {
 				// Must be an operator or a constructor since there is no other overloading
 				// Must be an operator or a constructor since there is no other overloading
@@ -195,6 +196,10 @@ public:
 				doc.errors_returned.push_back(errors_returned[i]);
 				doc.errors_returned.push_back(errors_returned[i]);
 			}
 			}
 
 
+			if (p_dict.has("keywords")) {
+				doc.keywords = p_dict["keywords"];
+			}
+
 			return doc;
 			return doc;
 		}
 		}
 		static Dictionary to_dict(const MethodDoc &p_doc) {
 		static Dictionary to_dict(const MethodDoc &p_doc) {
@@ -225,6 +230,10 @@ public:
 
 
 			dict["is_experimental"] = p_doc.is_experimental;
 			dict["is_experimental"] = p_doc.is_experimental;
 
 
+			if (!p_doc.keywords.is_empty()) {
+				dict["keywords"] = p_doc.keywords;
+			}
+
 			if (!p_doc.arguments.is_empty()) {
 			if (!p_doc.arguments.is_empty()) {
 				Array arguments;
 				Array arguments;
 				for (int i = 0; i < p_doc.arguments.size(); i++) {
 				for (int i = 0; i < p_doc.arguments.size(); i++) {
@@ -254,6 +263,7 @@ public:
 		String description;
 		String description;
 		bool is_deprecated = false;
 		bool is_deprecated = false;
 		bool is_experimental = false;
 		bool is_experimental = false;
+		String keywords;
 		bool operator<(const ConstantDoc &p_const) const {
 		bool operator<(const ConstantDoc &p_const) const {
 			return name < p_const.name;
 			return name < p_const.name;
 		}
 		}
@@ -291,6 +301,10 @@ public:
 				doc.is_experimental = p_dict["is_experimental"];
 				doc.is_experimental = p_dict["is_experimental"];
 			}
 			}
 
 
+			if (p_dict.has("keywords")) {
+				doc.keywords = p_dict["keywords"];
+			}
+
 			return doc;
 			return doc;
 		}
 		}
 		static Dictionary to_dict(const ConstantDoc &p_doc) {
 		static Dictionary to_dict(const ConstantDoc &p_doc) {
@@ -319,6 +333,10 @@ public:
 
 
 			dict["is_experimental"] = p_doc.is_experimental;
 			dict["is_experimental"] = p_doc.is_experimental;
 
 
+			if (!p_doc.keywords.is_empty()) {
+				dict["keywords"] = p_doc.keywords;
+			}
+
 			return dict;
 			return dict;
 		}
 		}
 	};
 	};
@@ -335,6 +353,7 @@ public:
 		String overrides;
 		String overrides;
 		bool is_deprecated = false;
 		bool is_deprecated = false;
 		bool is_experimental = false;
 		bool is_experimental = false;
+		String keywords;
 		bool operator<(const PropertyDoc &p_prop) const {
 		bool operator<(const PropertyDoc &p_prop) const {
 			return name.naturalcasecmp_to(p_prop.name) < 0;
 			return name.naturalcasecmp_to(p_prop.name) < 0;
 		}
 		}
@@ -388,6 +407,10 @@ public:
 				doc.is_experimental = p_dict["is_experimental"];
 				doc.is_experimental = p_dict["is_experimental"];
 			}
 			}
 
 
+			if (p_dict.has("keywords")) {
+				doc.keywords = p_dict["keywords"];
+			}
+
 			return doc;
 			return doc;
 		}
 		}
 		static Dictionary to_dict(const PropertyDoc &p_doc) {
 		static Dictionary to_dict(const PropertyDoc &p_doc) {
@@ -432,6 +455,10 @@ public:
 
 
 			dict["is_experimental"] = p_doc.is_experimental;
 			dict["is_experimental"] = p_doc.is_experimental;
 
 
+			if (!p_doc.keywords.is_empty()) {
+				dict["keywords"] = p_doc.keywords;
+			}
+
 			return dict;
 			return dict;
 		}
 		}
 	};
 	};
@@ -442,6 +469,7 @@ public:
 		String data_type;
 		String data_type;
 		String description;
 		String description;
 		String default_value;
 		String default_value;
+		String keywords;
 		bool operator<(const ThemeItemDoc &p_theme_item) const {
 		bool operator<(const ThemeItemDoc &p_theme_item) const {
 			// First sort by the data type, then by name.
 			// First sort by the data type, then by name.
 			if (data_type == p_theme_item.data_type) {
 			if (data_type == p_theme_item.data_type) {
@@ -472,6 +500,10 @@ public:
 				doc.default_value = p_dict["default_value"];
 				doc.default_value = p_dict["default_value"];
 			}
 			}
 
 
+			if (p_dict.has("keywords")) {
+				doc.keywords = p_dict["keywords"];
+			}
+
 			return doc;
 			return doc;
 		}
 		}
 		static Dictionary to_dict(const ThemeItemDoc &p_doc) {
 		static Dictionary to_dict(const ThemeItemDoc &p_doc) {
@@ -497,6 +529,10 @@ public:
 				dict["default_value"] = p_doc.default_value;
 				dict["default_value"] = p_doc.default_value;
 			}
 			}
 
 
+			if (!p_doc.keywords.is_empty()) {
+				dict["keywords"] = p_doc.keywords;
+			}
+
 			return dict;
 			return dict;
 		}
 		}
 	};
 	};
@@ -573,6 +609,7 @@ public:
 		String inherits;
 		String inherits;
 		String brief_description;
 		String brief_description;
 		String description;
 		String description;
+		String keywords;
 		Vector<TutorialDoc> tutorials;
 		Vector<TutorialDoc> tutorials;
 		Vector<MethodDoc> constructors;
 		Vector<MethodDoc> constructors;
 		Vector<MethodDoc> methods;
 		Vector<MethodDoc> methods;
@@ -609,6 +646,10 @@ public:
 				doc.description = p_dict["description"];
 				doc.description = p_dict["description"];
 			}
 			}
 
 
+			if (p_dict.has("keywords")) {
+				doc.keywords = p_dict["keywords"];
+			}
+
 			Array tutorials;
 			Array tutorials;
 			if (p_dict.has("tutorials")) {
 			if (p_dict.has("tutorials")) {
 				tutorials = p_dict["tutorials"];
 				tutorials = p_dict["tutorials"];
@@ -816,6 +857,10 @@ public:
 				dict["script_path"] = p_doc.script_path;
 				dict["script_path"] = p_doc.script_path;
 			}
 			}
 
 
+			if (!p_doc.keywords.is_empty()) {
+				dict["keywords"] = p_doc.keywords;
+			}
+
 			return dict;
 			return dict;
 		}
 		}
 	};
 	};

+ 7 - 0
doc/class.xsd

@@ -101,6 +101,7 @@
 									<xs:attribute type="xs:string" name="qualifiers" use="optional" />
 									<xs:attribute type="xs:string" name="qualifiers" use="optional" />
 									<xs:attribute type="xs:boolean" name="is_deprecated" use="optional" />
 									<xs:attribute type="xs:boolean" name="is_deprecated" use="optional" />
 									<xs:attribute type="xs:boolean" name="is_experimental" use="optional" />
 									<xs:attribute type="xs:boolean" name="is_experimental" use="optional" />
+									<xs:attribute type="xs:string" name="keywords" use="optional" />
 								</xs:complexType>
 								</xs:complexType>
 							</xs:element>
 							</xs:element>
 						</xs:sequence>
 						</xs:sequence>
@@ -123,6 +124,7 @@
 											<xs:attribute type="xs:string" name="default" use="optional" />
 											<xs:attribute type="xs:string" name="default" use="optional" />
 											<xs:attribute type="xs:boolean" name="is_deprecated" use="optional" />
 											<xs:attribute type="xs:boolean" name="is_deprecated" use="optional" />
 											<xs:attribute type="xs:boolean" name="is_experimental" use="optional" />
 											<xs:attribute type="xs:boolean" name="is_experimental" use="optional" />
+											<xs:attribute type="xs:string" name="keywords" use="optional" />
 										</xs:extension>
 										</xs:extension>
 									</xs:simpleContent>
 									</xs:simpleContent>
 								</xs:complexType>
 								</xs:complexType>
@@ -144,6 +146,7 @@
 												<xs:attribute type="xs:byte" name="index" />
 												<xs:attribute type="xs:byte" name="index" />
 												<xs:attribute type="xs:string" name="name" />
 												<xs:attribute type="xs:string" name="name" />
 												<xs:attribute type="xs:string" name="type" />
 												<xs:attribute type="xs:string" name="type" />
+												<xs:attribute type="xs:string" name="keywords" use="optional" />
 											</xs:complexType>
 											</xs:complexType>
 										</xs:element>
 										</xs:element>
 										<xs:element type="xs:string" name="description" />
 										<xs:element type="xs:string" name="description" />
@@ -169,6 +172,7 @@
 											<xs:attribute type="xs:boolean" name="is_bitfield" use="optional" />
 											<xs:attribute type="xs:boolean" name="is_bitfield" use="optional" />
 											<xs:attribute type="xs:boolean" name="is_deprecated" use="optional" />
 											<xs:attribute type="xs:boolean" name="is_deprecated" use="optional" />
 											<xs:attribute type="xs:boolean" name="is_experimental" use="optional" />
 											<xs:attribute type="xs:boolean" name="is_experimental" use="optional" />
+											<xs:attribute type="xs:string" name="keywords" use="optional" />
 										</xs:extension>
 										</xs:extension>
 									</xs:simpleContent>
 									</xs:simpleContent>
 								</xs:complexType>
 								</xs:complexType>
@@ -209,6 +213,7 @@
 									</xs:sequence>
 									</xs:sequence>
 									<xs:attribute type="xs:string" name="name" use="optional" />
 									<xs:attribute type="xs:string" name="name" use="optional" />
 									<xs:attribute type="xs:string" name="qualifiers" use="optional" />
 									<xs:attribute type="xs:string" name="qualifiers" use="optional" />
+									<xs:attribute type="xs:string" name="keywords" use="optional" />
 								</xs:complexType>
 								</xs:complexType>
 							</xs:element>
 							</xs:element>
 						</xs:sequence>
 						</xs:sequence>
@@ -225,6 +230,7 @@
 											<xs:attribute type="xs:string" name="data_type" />
 											<xs:attribute type="xs:string" name="data_type" />
 											<xs:attribute type="xs:string" name="type" />
 											<xs:attribute type="xs:string" name="type" />
 											<xs:attribute type="xs:string" name="default" use="optional" />
 											<xs:attribute type="xs:string" name="default" use="optional" />
+											<xs:attribute type="xs:string" name="keywords" use="optional" />
 										</xs:extension>
 										</xs:extension>
 									</xs:simpleContent>
 									</xs:simpleContent>
 								</xs:complexType>
 								</xs:complexType>
@@ -275,6 +281,7 @@
 			<xs:attribute type="xs:string" name="inherits" />
 			<xs:attribute type="xs:string" name="inherits" />
 			<xs:attribute type="xs:boolean" name="is_deprecated" use="optional" />
 			<xs:attribute type="xs:boolean" name="is_deprecated" use="optional" />
 			<xs:attribute type="xs:boolean" name="is_experimental" use="optional" />
 			<xs:attribute type="xs:boolean" name="is_experimental" use="optional" />
+			<xs:attribute type="xs:string" name="keywords" use="optional" />
 		</xs:complexType>
 		</xs:complexType>
 	</xs:element>
 	</xs:element>
 </xs:schema>
 </xs:schema>

+ 9 - 0
doc/tools/make_rst.py

@@ -166,6 +166,10 @@ class State:
         if desc is not None and desc.text:
         if desc is not None and desc.text:
             class_def.description = desc.text
             class_def.description = desc.text
 
 
+        keywords = class_root.get("keywords")
+        if keywords is not None:
+            class_def.keywords = keywords
+
         properties = class_root.find("members")
         properties = class_root.find("members")
         if properties is not None:
         if properties is not None:
             for property in properties:
             for property in properties:
@@ -564,6 +568,7 @@ class ClassDef(DefinitionBase):
         self.brief_description: Optional[str] = None
         self.brief_description: Optional[str] = None
         self.description: Optional[str] = None
         self.description: Optional[str] = None
         self.tutorials: List[Tuple[str, str]] = []
         self.tutorials: List[Tuple[str, str]] = []
+        self.keywords: Optional[str] = None
 
 
         # Used to match the class with XML source for output filtering purposes.
         # Used to match the class with XML source for output filtering purposes.
         self.filepath: str = ""
         self.filepath: str = ""
@@ -866,6 +871,10 @@ def make_rst_class(class_def: ClassDef, state: State, dry_run: bool, output_dir:
     # Remove the "Edit on Github" button from the online docs page.
     # Remove the "Edit on Github" button from the online docs page.
     f.write(":github_url: hide\n\n")
     f.write(":github_url: hide\n\n")
 
 
+    # Add keywords metadata.
+    if class_def.keywords is not None and class_def.keywords != "":
+        f.write(f".. meta::\n\t:keywords: {class_def.keywords}\n\n")
+
     # Warn contributors not to edit this file directly.
     # Warn contributors not to edit this file directly.
     # Also provide links to the source files for reference.
     # Also provide links to the source files for reference.
 
 

+ 45 - 8
editor/doc_tools.cpp

@@ -88,6 +88,7 @@ void DocTools::merge_from(const DocTools &p_data) {
 
 
 		c.is_deprecated = cf.is_deprecated;
 		c.is_deprecated = cf.is_deprecated;
 		c.is_experimental = cf.is_experimental;
 		c.is_experimental = cf.is_experimental;
+		c.keywords = cf.keywords;
 
 
 		c.description = cf.description;
 		c.description = cf.description;
 		c.brief_description = cf.brief_description;
 		c.brief_description = cf.brief_description;
@@ -156,6 +157,7 @@ void DocTools::merge_from(const DocTools &p_data) {
 				m.description = mf.description;
 				m.description = mf.description;
 				m.is_deprecated = mf.is_deprecated;
 				m.is_deprecated = mf.is_deprecated;
 				m.is_experimental = mf.is_experimental;
 				m.is_experimental = mf.is_experimental;
+				m.keywords = mf.keywords;
 				break;
 				break;
 			}
 			}
 		}
 		}
@@ -172,6 +174,7 @@ void DocTools::merge_from(const DocTools &p_data) {
 				m.description = mf.description;
 				m.description = mf.description;
 				m.is_deprecated = mf.is_deprecated;
 				m.is_deprecated = mf.is_deprecated;
 				m.is_experimental = mf.is_experimental;
 				m.is_experimental = mf.is_experimental;
+				m.keywords = mf.keywords;
 				break;
 				break;
 			}
 			}
 		}
 		}
@@ -188,6 +191,7 @@ void DocTools::merge_from(const DocTools &p_data) {
 				m.description = mf.description;
 				m.description = mf.description;
 				m.is_deprecated = mf.is_deprecated;
 				m.is_deprecated = mf.is_deprecated;
 				m.is_experimental = mf.is_experimental;
 				m.is_experimental = mf.is_experimental;
+				m.keywords = mf.keywords;
 				break;
 				break;
 			}
 			}
 		}
 		}
@@ -204,6 +208,7 @@ void DocTools::merge_from(const DocTools &p_data) {
 				m.description = mf.description;
 				m.description = mf.description;
 				m.is_deprecated = mf.is_deprecated;
 				m.is_deprecated = mf.is_deprecated;
 				m.is_experimental = mf.is_experimental;
 				m.is_experimental = mf.is_experimental;
+				m.keywords = mf.keywords;
 				break;
 				break;
 			}
 			}
 		}
 		}
@@ -220,6 +225,7 @@ void DocTools::merge_from(const DocTools &p_data) {
 				p.description = pf.description;
 				p.description = pf.description;
 				p.is_deprecated = pf.is_deprecated;
 				p.is_deprecated = pf.is_deprecated;
 				p.is_experimental = pf.is_experimental;
 				p.is_experimental = pf.is_experimental;
+				p.keywords = pf.keywords;
 				break;
 				break;
 			}
 			}
 		}
 		}
@@ -234,6 +240,7 @@ void DocTools::merge_from(const DocTools &p_data) {
 				const DocData::ThemeItemDoc &pf = cf.theme_properties[j];
 				const DocData::ThemeItemDoc &pf = cf.theme_properties[j];
 
 
 				ti.description = pf.description;
 				ti.description = pf.description;
+				ti.keywords = pf.keywords;
 				break;
 				break;
 			}
 			}
 		}
 		}
@@ -1067,6 +1074,9 @@ static Error _parse_methods(Ref<XMLParser> &parser, Vector<DocData::MethodDoc> &
 				if (parser->has_attribute("is_experimental")) {
 				if (parser->has_attribute("is_experimental")) {
 					method.is_experimental = parser->get_named_attribute_value("is_experimental").to_lower() == "true";
 					method.is_experimental = parser->get_named_attribute_value("is_experimental").to_lower() == "true";
 				}
 				}
+				if (parser->has_attribute("keywords")) {
+					method.keywords = parser->get_named_attribute_value("keywords");
+				}
 
 
 				while (parser->read() == OK) {
 				while (parser->read() == OK) {
 					if (parser->get_node_type() == XMLParser::NODE_ELEMENT) {
 					if (parser->get_node_type() == XMLParser::NODE_ELEMENT) {
@@ -1214,6 +1224,10 @@ Error DocTools::_load(Ref<XMLParser> parser) {
 			c.is_experimental = parser->get_named_attribute_value("is_experimental").to_lower() == "true";
 			c.is_experimental = parser->get_named_attribute_value("is_experimental").to_lower() == "true";
 		}
 		}
 
 
+		if (parser->has_attribute("keywords")) {
+			c.keywords = parser->get_named_attribute_value("keywords");
+		}
+
 		while (parser->read() == OK) {
 		while (parser->read() == OK) {
 			if (parser->get_node_type() == XMLParser::NODE_ELEMENT) {
 			if (parser->get_node_type() == XMLParser::NODE_ELEMENT) {
 				String name2 = parser->get_node_name();
 				String name2 = parser->get_node_name();
@@ -1296,6 +1310,9 @@ Error DocTools::_load(Ref<XMLParser> parser) {
 								if (parser->has_attribute("is_experimental")) {
 								if (parser->has_attribute("is_experimental")) {
 									prop2.is_experimental = parser->get_named_attribute_value("is_experimental").to_lower() == "true";
 									prop2.is_experimental = parser->get_named_attribute_value("is_experimental").to_lower() == "true";
 								}
 								}
+								if (parser->has_attribute("keywords")) {
+									prop2.keywords = parser->get_named_attribute_value("keywords");
+								}
 								if (!parser->is_empty()) {
 								if (!parser->is_empty()) {
 									parser->read();
 									parser->read();
 									if (parser->get_node_type() == XMLParser::NODE_TEXT) {
 									if (parser->get_node_type() == XMLParser::NODE_TEXT) {
@@ -1326,6 +1343,9 @@ Error DocTools::_load(Ref<XMLParser> parser) {
 								prop2.type = parser->get_named_attribute_value("type");
 								prop2.type = parser->get_named_attribute_value("type");
 								ERR_FAIL_COND_V(!parser->has_attribute("data_type"), ERR_FILE_CORRUPT);
 								ERR_FAIL_COND_V(!parser->has_attribute("data_type"), ERR_FILE_CORRUPT);
 								prop2.data_type = parser->get_named_attribute_value("data_type");
 								prop2.data_type = parser->get_named_attribute_value("data_type");
+								if (parser->has_attribute("keywords")) {
+									prop2.keywords = parser->get_named_attribute_value("keywords");
+								}
 								if (!parser->is_empty()) {
 								if (!parser->is_empty()) {
 									parser->read();
 									parser->read();
 									if (parser->get_node_type() == XMLParser::NODE_TEXT) {
 									if (parser->get_node_type() == XMLParser::NODE_TEXT) {
@@ -1366,6 +1386,9 @@ Error DocTools::_load(Ref<XMLParser> parser) {
 								if (parser->has_attribute("is_experimental")) {
 								if (parser->has_attribute("is_experimental")) {
 									constant2.is_experimental = parser->get_named_attribute_value("is_experimental").to_lower() == "true";
 									constant2.is_experimental = parser->get_named_attribute_value("is_experimental").to_lower() == "true";
 								}
 								}
+								if (parser->has_attribute("keywords")) {
+									constant2.keywords = parser->get_named_attribute_value("keywords");
+								}
 								if (!parser->is_empty()) {
 								if (!parser->is_empty()) {
 									parser->read();
 									parser->read();
 									if (parser->get_node_type() == XMLParser::NODE_TEXT) {
 									if (parser->get_node_type() == XMLParser::NODE_TEXT) {
@@ -1410,20 +1433,21 @@ static void _write_method_doc(Ref<FileAccess> f, const String &p_name, Vector<Do
 		for (int i = 0; i < p_method_docs.size(); i++) {
 		for (int i = 0; i < p_method_docs.size(); i++) {
 			const DocData::MethodDoc &m = p_method_docs[i];
 			const DocData::MethodDoc &m = p_method_docs[i];
 
 
-			String qualifiers;
+			String additional_attributes;
 			if (!m.qualifiers.is_empty()) {
 			if (!m.qualifiers.is_empty()) {
-				qualifiers += " qualifiers=\"" + m.qualifiers.xml_escape() + "\"";
+				additional_attributes += " qualifiers=\"" + m.qualifiers.xml_escape(true) + "\"";
 			}
 			}
-
-			String additional_attributes;
 			if (m.is_deprecated) {
 			if (m.is_deprecated) {
 				additional_attributes += " is_deprecated=\"true\"";
 				additional_attributes += " is_deprecated=\"true\"";
 			}
 			}
 			if (m.is_experimental) {
 			if (m.is_experimental) {
 				additional_attributes += " is_experimental=\"true\"";
 				additional_attributes += " is_experimental=\"true\"";
 			}
 			}
+			if (!m.keywords.is_empty()) {
+				additional_attributes += String(" keywords=\"") + m.keywords.xml_escape(true) + "\"";
+			}
 
 
-			_write_string(f, 2, "<" + p_name + " name=\"" + m.name.xml_escape() + "\"" + qualifiers + additional_attributes + ">");
+			_write_string(f, 2, "<" + p_name + " name=\"" + m.name.xml_escape() + "\"" + additional_attributes + ">");
 
 
 			if (!m.return_type.is_empty()) {
 			if (!m.return_type.is_empty()) {
 				String enum_text;
 				String enum_text;
@@ -1499,6 +1523,9 @@ Error DocTools::save_classes(const String &p_default_path, const HashMap<String,
 				header += " is_experimental=\"true\"";
 				header += " is_experimental=\"true\"";
 			}
 			}
 		}
 		}
+		if (!c.keywords.is_empty()) {
+			header += String(" keywords=\"") + c.keywords.xml_escape(true) + "\"";
+		}
 		if (p_include_xml_schema) {
 		if (p_include_xml_schema) {
 			// Reference the XML schema so editors can provide error checking.
 			// Reference the XML schema so editors can provide error checking.
 			// Modules are nested deep, so change the path to reference the same schema everywhere.
 			// Modules are nested deep, so change the path to reference the same schema everywhere.
@@ -1552,6 +1579,9 @@ Error DocTools::save_classes(const String &p_default_path, const HashMap<String,
 				if (c.properties[i].is_experimental) {
 				if (c.properties[i].is_experimental) {
 					additional_attributes += " is_experimental=\"true\"";
 					additional_attributes += " is_experimental=\"true\"";
 				}
 				}
+				if (!c.properties[i].keywords.is_empty()) {
+					additional_attributes += String(" keywords=\"") + c.properties[i].keywords.xml_escape(true) + "\"";
+				}
 
 
 				const DocData::PropertyDoc &p = c.properties[i];
 				const DocData::PropertyDoc &p = c.properties[i];
 
 
@@ -1580,6 +1610,9 @@ Error DocTools::save_classes(const String &p_default_path, const HashMap<String,
 				if (c.constants[i].is_experimental) {
 				if (c.constants[i].is_experimental) {
 					additional_attributes += " is_experimental=\"true\"";
 					additional_attributes += " is_experimental=\"true\"";
 				}
 				}
+				if (!c.constants[i].keywords.is_empty()) {
+					additional_attributes += String(" keywords=\"") + c.constants[i].keywords.xml_escape(true) + "\"";
+				}
 
 
 				if (k.is_value_valid) {
 				if (k.is_value_valid) {
 					if (!k.enumeration.is_empty()) {
 					if (!k.enumeration.is_empty()) {
@@ -1614,11 +1647,15 @@ Error DocTools::save_classes(const String &p_default_path, const HashMap<String,
 			for (int i = 0; i < c.theme_properties.size(); i++) {
 			for (int i = 0; i < c.theme_properties.size(); i++) {
 				const DocData::ThemeItemDoc &ti = c.theme_properties[i];
 				const DocData::ThemeItemDoc &ti = c.theme_properties[i];
 
 
+				String additional_attributes;
 				if (!ti.default_value.is_empty()) {
 				if (!ti.default_value.is_empty()) {
-					_write_string(f, 2, "<theme_item name=\"" + ti.name + "\" data_type=\"" + ti.data_type + "\" type=\"" + ti.type + "\" default=\"" + ti.default_value.xml_escape(true) + "\">");
-				} else {
-					_write_string(f, 2, "<theme_item name=\"" + ti.name + "\" data_type=\"" + ti.data_type + "\" type=\"" + ti.type + "\">");
+					additional_attributes += String(" default=\"") + ti.default_value.xml_escape(true) + "\"";
 				}
 				}
+				if (!ti.keywords.is_empty()) {
+					additional_attributes += String(" keywords=\"") + ti.keywords.xml_escape(true) + "\"";
+				}
+
+				_write_string(f, 2, "<theme_item name=\"" + ti.name + "\" data_type=\"" + ti.data_type + "\" type=\"" + ti.type + "\"" + additional_attributes + ">");
 
 
 				_write_string(f, 3, _translate_doc_string(ti.description).strip_edges().xml_escape());
 				_write_string(f, 3, _translate_doc_string(ti.description).strip_edges().xml_escape());
 
 

+ 51 - 17
editor/editor_help_search.cpp

@@ -369,7 +369,7 @@ bool EditorHelpSearch::Runner::_phase_match_classes() {
 			// If the search term is empty, add any classes which are not script docs or which don't start with
 			// If the search term is empty, add any classes which are not script docs or which don't start with
 			// a double-quotation. This will ensure that only C++ classes and explicitly named classes will
 			// a double-quotation. This will ensure that only C++ classes and explicitly named classes will
 			// be added.
 			// be added.
-			match.name = (term.is_empty() && (!class_doc->is_script_doc || class_doc->name[0] != '\"')) || _match_string(term, class_doc->name);
+			match.name = (term.is_empty() && (!class_doc->is_script_doc || class_doc->name[0] != '\"')) || _match_string(term, class_doc->name) || _match_keywords(term, class_doc->keywords);
 		}
 		}
 
 
 		// Match members only if the term is long enough, to avoid slow performance from building a large tree.
 		// Match members only if the term is long enough, to avoid slow performance from building a large tree.
@@ -386,35 +386,35 @@ bool EditorHelpSearch::Runner::_phase_match_classes() {
 			}
 			}
 			if (search_flags & SEARCH_SIGNALS) {
 			if (search_flags & SEARCH_SIGNALS) {
 				for (int i = 0; i < class_doc->signals.size(); i++) {
 				for (int i = 0; i < class_doc->signals.size(); i++) {
-					if (_all_terms_in_name(class_doc->signals[i].name)) {
+					if (_all_terms_in_name(class_doc->signals[i].name) || _all_terms_in_keywords(class_doc->signals[i].keywords)) {
 						match.signals.push_back(const_cast<DocData::MethodDoc *>(&class_doc->signals[i]));
 						match.signals.push_back(const_cast<DocData::MethodDoc *>(&class_doc->signals[i]));
 					}
 					}
 				}
 				}
 			}
 			}
 			if (search_flags & SEARCH_CONSTANTS) {
 			if (search_flags & SEARCH_CONSTANTS) {
 				for (int i = 0; i < class_doc->constants.size(); i++) {
 				for (int i = 0; i < class_doc->constants.size(); i++) {
-					if (_all_terms_in_name(class_doc->constants[i].name)) {
+					if (_all_terms_in_name(class_doc->constants[i].name) || _all_terms_in_keywords(class_doc->constants[i].keywords)) {
 						match.constants.push_back(const_cast<DocData::ConstantDoc *>(&class_doc->constants[i]));
 						match.constants.push_back(const_cast<DocData::ConstantDoc *>(&class_doc->constants[i]));
 					}
 					}
 				}
 				}
 			}
 			}
 			if (search_flags & SEARCH_PROPERTIES) {
 			if (search_flags & SEARCH_PROPERTIES) {
 				for (int i = 0; i < class_doc->properties.size(); i++) {
 				for (int i = 0; i < class_doc->properties.size(); i++) {
-					if (_all_terms_in_name(class_doc->properties[i].name)) {
+					if (_all_terms_in_name(class_doc->properties[i].name) || _all_terms_in_keywords(class_doc->properties[i].keywords)) {
 						match.properties.push_back(const_cast<DocData::PropertyDoc *>(&class_doc->properties[i]));
 						match.properties.push_back(const_cast<DocData::PropertyDoc *>(&class_doc->properties[i]));
 					}
 					}
 				}
 				}
 			}
 			}
 			if (search_flags & SEARCH_THEME_ITEMS) {
 			if (search_flags & SEARCH_THEME_ITEMS) {
 				for (int i = 0; i < class_doc->theme_properties.size(); i++) {
 				for (int i = 0; i < class_doc->theme_properties.size(); i++) {
-					if (_all_terms_in_name(class_doc->theme_properties[i].name)) {
+					if (_all_terms_in_name(class_doc->theme_properties[i].name) || _all_terms_in_keywords(class_doc->theme_properties[i].keywords)) {
 						match.theme_properties.push_back(const_cast<DocData::ThemeItemDoc *>(&class_doc->theme_properties[i]));
 						match.theme_properties.push_back(const_cast<DocData::ThemeItemDoc *>(&class_doc->theme_properties[i]));
 					}
 					}
 				}
 				}
 			}
 			}
 			if (search_flags & SEARCH_ANNOTATIONS) {
 			if (search_flags & SEARCH_ANNOTATIONS) {
 				for (int i = 0; i < class_doc->annotations.size(); i++) {
 				for (int i = 0; i < class_doc->annotations.size(); i++) {
-					if (_match_string(term, class_doc->annotations[i].name)) {
+					if (_match_string(term, class_doc->annotations[i].name) || _all_terms_in_keywords(class_doc->annotations[i].keywords)) {
 						match.annotations.push_back(const_cast<DocData::MethodDoc *>(&class_doc->annotations[i]));
 						match.annotations.push_back(const_cast<DocData::MethodDoc *>(&class_doc->annotations[i]));
 					}
 					}
 				}
 				}
@@ -574,7 +574,8 @@ void EditorHelpSearch::Runner::_match_method_name_and_push_back(Vector<DocData::
 	// Constructors, Methods, Operators...
 	// Constructors, Methods, Operators...
 	for (int i = 0; i < p_methods.size(); i++) {
 	for (int i = 0; i < p_methods.size(); i++) {
 		String method_name = (search_flags & SEARCH_CASE_SENSITIVE) ? p_methods[i].name : p_methods[i].name.to_lower();
 		String method_name = (search_flags & SEARCH_CASE_SENSITIVE) ? p_methods[i].name : p_methods[i].name.to_lower();
-		if (_all_terms_in_name(method_name) ||
+		String keywords = (search_flags & SEARCH_CASE_SENSITIVE) ? p_methods[i].keywords : p_methods[i].keywords.to_lower();
+		if (_all_terms_in_name(method_name) || _all_terms_in_keywords(keywords) ||
 				(term.begins_with(".") && method_name.begins_with(term.substr(1))) ||
 				(term.begins_with(".") && method_name.begins_with(term.substr(1))) ||
 				(term.ends_with("(") && method_name.ends_with(term.left(term.length() - 1).strip_edges())) ||
 				(term.ends_with("(") && method_name.ends_with(term.left(term.length() - 1).strip_edges())) ||
 				(term.begins_with(".") && term.ends_with("(") && method_name == term.substr(1, term.length() - 2).strip_edges())) {
 				(term.begins_with(".") && term.ends_with("(") && method_name == term.substr(1, term.length() - 2).strip_edges())) {
@@ -583,15 +584,24 @@ void EditorHelpSearch::Runner::_match_method_name_and_push_back(Vector<DocData::
 	}
 	}
 }
 }
 
 
-bool EditorHelpSearch::Runner::_all_terms_in_name(String name) {
+bool EditorHelpSearch::Runner::_all_terms_in_name(const String &p_name) const {
 	for (int i = 0; i < terms.size(); i++) {
 	for (int i = 0; i < terms.size(); i++) {
-		if (!_match_string(terms[i], name)) {
+		if (!_match_string(terms[i], p_name)) {
 			return false;
 			return false;
 		}
 		}
 	}
 	}
 	return true;
 	return true;
 }
 }
 
 
+bool EditorHelpSearch::Runner::_all_terms_in_keywords(const String &p_keywords) const {
+	for (const String &keyword : p_keywords.split(",")) {
+		if (_all_terms_in_name(keyword.strip_edges())) {
+			return true;
+		}
+	}
+	return false;
+}
+
 bool EditorHelpSearch::Runner::_match_string(const String &p_term, const String &p_string) const {
 bool EditorHelpSearch::Runner::_match_string(const String &p_term, const String &p_string) const {
 	if (search_flags & SEARCH_CASE_SENSITIVE) {
 	if (search_flags & SEARCH_CASE_SENSITIVE) {
 		return p_string.find(p_term) > -1;
 		return p_string.find(p_term) > -1;
@@ -600,7 +610,20 @@ bool EditorHelpSearch::Runner::_match_string(const String &p_term, const String
 	}
 	}
 }
 }
 
 
-void EditorHelpSearch::Runner::_match_item(TreeItem *p_item, const String &p_text) {
+bool EditorHelpSearch::Runner::_match_keywords(const String &p_term, const String &p_keywords) const {
+	for (const String &keyword : p_keywords.split(",")) {
+		if (_match_string(p_term, keyword.strip_edges())) {
+			return true;
+		}
+	}
+	return false;
+}
+
+void EditorHelpSearch::Runner::_match_item(TreeItem *p_item, const String &p_text, bool p_is_keywords) {
+	if (p_text.is_empty()) {
+		return;
+	}
+
 	float inverse_length = 1.f / float(p_text.length());
 	float inverse_length = 1.f / float(p_text.length());
 
 
 	// Favor types where search term is a substring close to the start of the type.
 	// Favor types where search term is a substring close to the start of the type.
@@ -612,6 +635,11 @@ void EditorHelpSearch::Runner::_match_item(TreeItem *p_item, const String &p_tex
 	w = 0.1f;
 	w = 0.1f;
 	score *= (1 - w) + w * (term.length() * inverse_length);
 	score *= (1 - w) + w * (term.length() * inverse_length);
 
 
+	// Reduce the score of keywords, since they are an indirect match.
+	if (p_is_keywords) {
+		score *= 0.9f;
+	}
+
 	if (match_highest_score == 0 || score > match_highest_score) {
 	if (match_highest_score == 0 || score > match_highest_score) {
 		matched_item = p_item;
 		matched_item = p_item;
 		match_highest_score = score;
 		match_highest_score = score;
@@ -711,43 +739,46 @@ TreeItem *EditorHelpSearch::Runner::_create_class_item(TreeItem *p_parent, const
 	}
 	}
 
 
 	_match_item(item, p_doc->name);
 	_match_item(item, p_doc->name);
+	for (const String &keyword : p_doc->keywords.split(",")) {
+		_match_item(item, keyword.strip_edges(), true);
+	}
 
 
 	return item;
 	return item;
 }
 }
 
 
 TreeItem *EditorHelpSearch::Runner::_create_method_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const String &p_text, const DocData::MethodDoc *p_doc) {
 TreeItem *EditorHelpSearch::Runner::_create_method_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const String &p_text, const DocData::MethodDoc *p_doc) {
 	String tooltip = _build_method_tooltip(p_class_doc, p_doc);
 	String tooltip = _build_method_tooltip(p_class_doc, p_doc);
-	return _create_member_item(p_parent, p_class_doc->name, "MemberMethod", p_doc->name, p_text, TTRC("Method"), "method", tooltip, p_doc->is_deprecated, p_doc->is_experimental);
+	return _create_member_item(p_parent, p_class_doc->name, "MemberMethod", p_doc->name, p_text, TTRC("Method"), "method", tooltip, p_doc->keywords, p_doc->is_deprecated, p_doc->is_experimental);
 }
 }
 
 
 TreeItem *EditorHelpSearch::Runner::_create_signal_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::MethodDoc *p_doc) {
 TreeItem *EditorHelpSearch::Runner::_create_signal_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::MethodDoc *p_doc) {
 	String tooltip = _build_method_tooltip(p_class_doc, p_doc);
 	String tooltip = _build_method_tooltip(p_class_doc, p_doc);
-	return _create_member_item(p_parent, p_class_doc->name, "MemberSignal", p_doc->name, p_doc->name, TTRC("Signal"), "signal", tooltip, p_doc->is_deprecated, p_doc->is_experimental);
+	return _create_member_item(p_parent, p_class_doc->name, "MemberSignal", p_doc->name, p_doc->name, TTRC("Signal"), "signal", tooltip, p_doc->keywords, p_doc->is_deprecated, p_doc->is_experimental);
 }
 }
 
 
 TreeItem *EditorHelpSearch::Runner::_create_annotation_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const String &p_text, const DocData::MethodDoc *p_doc) {
 TreeItem *EditorHelpSearch::Runner::_create_annotation_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const String &p_text, const DocData::MethodDoc *p_doc) {
 	String tooltip = _build_method_tooltip(p_class_doc, p_doc);
 	String tooltip = _build_method_tooltip(p_class_doc, p_doc);
-	return _create_member_item(p_parent, p_class_doc->name, "MemberAnnotation", p_doc->name, p_text, TTRC("Annotation"), "annotation", tooltip, p_doc->is_deprecated, p_doc->is_experimental);
+	return _create_member_item(p_parent, p_class_doc->name, "MemberAnnotation", p_doc->name, p_text, TTRC("Annotation"), "annotation", tooltip, p_doc->keywords, p_doc->is_deprecated, p_doc->is_experimental);
 }
 }
 
 
 TreeItem *EditorHelpSearch::Runner::_create_constant_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ConstantDoc *p_doc) {
 TreeItem *EditorHelpSearch::Runner::_create_constant_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ConstantDoc *p_doc) {
 	String tooltip = p_class_doc->name + "." + p_doc->name;
 	String tooltip = p_class_doc->name + "." + p_doc->name;
-	return _create_member_item(p_parent, p_class_doc->name, "MemberConstant", p_doc->name, p_doc->name, TTRC("Constant"), "constant", tooltip, p_doc->is_deprecated, p_doc->is_experimental);
+	return _create_member_item(p_parent, p_class_doc->name, "MemberConstant", p_doc->name, p_doc->name, TTRC("Constant"), "constant", tooltip, p_doc->keywords, p_doc->is_deprecated, p_doc->is_experimental);
 }
 }
 
 
 TreeItem *EditorHelpSearch::Runner::_create_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::PropertyDoc *p_doc) {
 TreeItem *EditorHelpSearch::Runner::_create_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::PropertyDoc *p_doc) {
 	String tooltip = p_doc->type + " " + p_class_doc->name + "." + p_doc->name;
 	String tooltip = p_doc->type + " " + p_class_doc->name + "." + p_doc->name;
 	tooltip += "\n    " + p_class_doc->name + "." + p_doc->setter + "(value) setter";
 	tooltip += "\n    " + p_class_doc->name + "." + p_doc->setter + "(value) setter";
 	tooltip += "\n    " + p_class_doc->name + "." + p_doc->getter + "() getter";
 	tooltip += "\n    " + p_class_doc->name + "." + p_doc->getter + "() getter";
-	return _create_member_item(p_parent, p_class_doc->name, "MemberProperty", p_doc->name, p_doc->name, TTRC("Property"), "property", tooltip, p_doc->is_deprecated, p_doc->is_experimental);
+	return _create_member_item(p_parent, p_class_doc->name, "MemberProperty", p_doc->name, p_doc->name, TTRC("Property"), "property", tooltip, p_doc->keywords, p_doc->is_deprecated, p_doc->is_experimental);
 }
 }
 
 
 TreeItem *EditorHelpSearch::Runner::_create_theme_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ThemeItemDoc *p_doc) {
 TreeItem *EditorHelpSearch::Runner::_create_theme_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ThemeItemDoc *p_doc) {
 	String tooltip = p_doc->type + " " + p_class_doc->name + "." + p_doc->name;
 	String tooltip = p_doc->type + " " + p_class_doc->name + "." + p_doc->name;
-	return _create_member_item(p_parent, p_class_doc->name, "MemberTheme", p_doc->name, p_doc->name, TTRC("Theme Property"), "theme_item", tooltip, false, false);
+	return _create_member_item(p_parent, p_class_doc->name, "MemberTheme", p_doc->name, p_doc->name, TTRC("Theme Property"), "theme_item", p_doc->keywords, tooltip, false, false);
 }
 }
 
 
-TreeItem *EditorHelpSearch::Runner::_create_member_item(TreeItem *p_parent, const String &p_class_name, const String &p_icon, const String &p_name, const String &p_text, const String &p_type, const String &p_metatype, const String &p_tooltip, bool is_deprecated, bool is_experimental) {
+TreeItem *EditorHelpSearch::Runner::_create_member_item(TreeItem *p_parent, const String &p_class_name, const String &p_icon, const String &p_name, const String &p_text, const String &p_type, const String &p_metatype, const String &p_tooltip, const String &p_keywords, bool is_deprecated, bool is_experimental) {
 	const String item_meta = "class_" + p_metatype + ":" + p_class_name + ":" + p_name;
 	const String item_meta = "class_" + p_metatype + ":" + p_class_name + ":" + p_name;
 
 
 	TreeItem *item = nullptr;
 	TreeItem *item = nullptr;
@@ -774,6 +805,9 @@ TreeItem *EditorHelpSearch::Runner::_create_member_item(TreeItem *p_parent, cons
 	}
 	}
 
 
 	_match_item(item, p_name);
 	_match_item(item, p_name);
+	for (const String &keyword : p_keywords.split(",")) {
+		_match_item(item, keyword.strip_edges(), true);
+	}
 
 
 	return item;
 	return item;
 }
 }

+ 5 - 3
editor/editor_help_search.h

@@ -160,9 +160,11 @@ class EditorHelpSearch::Runner : public RefCounted {
 	String _build_method_tooltip(const DocData::ClassDoc *p_class_doc, const DocData::MethodDoc *p_doc) const;
 	String _build_method_tooltip(const DocData::ClassDoc *p_class_doc, const DocData::MethodDoc *p_doc) const;
 
 
 	void _match_method_name_and_push_back(Vector<DocData::MethodDoc> &p_methods, Vector<DocData::MethodDoc *> *r_match_methods);
 	void _match_method_name_and_push_back(Vector<DocData::MethodDoc> &p_methods, Vector<DocData::MethodDoc *> *r_match_methods);
-	bool _all_terms_in_name(String name);
+	bool _all_terms_in_name(const String &p_name) const;
+	bool _all_terms_in_keywords(const String &p_name) const;
 	bool _match_string(const String &p_term, const String &p_string) const;
 	bool _match_string(const String &p_term, const String &p_string) const;
-	void _match_item(TreeItem *p_item, const String &p_text);
+	bool _match_keywords(const String &p_term, const String &p_keywords) const;
+	void _match_item(TreeItem *p_item, const String &p_text, bool p_is_keywords = false);
 	TreeItem *_create_class_hierarchy(const ClassMatch &p_match);
 	TreeItem *_create_class_hierarchy(const ClassMatch &p_match);
 	TreeItem *_create_class_item(TreeItem *p_parent, const DocData::ClassDoc *p_doc, bool p_gray);
 	TreeItem *_create_class_item(TreeItem *p_parent, const DocData::ClassDoc *p_doc, bool p_gray);
 	TreeItem *_create_method_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const String &p_text, const DocData::MethodDoc *p_doc);
 	TreeItem *_create_method_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const String &p_text, const DocData::MethodDoc *p_doc);
@@ -171,7 +173,7 @@ class EditorHelpSearch::Runner : public RefCounted {
 	TreeItem *_create_constant_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ConstantDoc *p_doc);
 	TreeItem *_create_constant_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ConstantDoc *p_doc);
 	TreeItem *_create_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::PropertyDoc *p_doc);
 	TreeItem *_create_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::PropertyDoc *p_doc);
 	TreeItem *_create_theme_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ThemeItemDoc *p_doc);
 	TreeItem *_create_theme_property_item(TreeItem *p_parent, const DocData::ClassDoc *p_class_doc, const DocData::ThemeItemDoc *p_doc);
-	TreeItem *_create_member_item(TreeItem *p_parent, const String &p_class_name, const String &p_icon, const String &p_name, const String &p_text, const String &p_type, const String &p_metatype, const String &p_tooltip, bool is_deprecated, bool is_experimental);
+	TreeItem *_create_member_item(TreeItem *p_parent, const String &p_class_name, const String &p_icon, const String &p_name, const String &p_text, const String &p_type, const String &p_metatype, const String &p_tooltip, const String &p_keywords, bool is_deprecated, bool is_experimental);
 
 
 public:
 public:
 	bool work(uint64_t slot = 100000);
 	bool work(uint64_t slot = 100000);