godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-12-03 16:55:53 +00:00
Code Releases Wiki Activity

Optimize the custom doc for shaders.

Browse Source 
Remove add_doc for gdshader files without documentation.
Standardize the class_doc.name for custom documentation.
This commit is contained in:
Magian
2025-11-21 01:12:09 +08:00
parent 7864ac8019
commit 42c683d450
2 changed files with 12 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
editor/inspector/editor_inspector.cpp
View File

@@ -4338,10 +4338,7 @@ void EditorInspector::update_tree() {
// `|` separators used in `EditorHelpBit`. // `|` separators used in `EditorHelpBit`.
if (theme_item_name.is_empty()) { if (theme_item_name.is_empty()) {
if (p.name.contains("shader_parameter/")) { if (p.name.contains("shader_parameter/")) {
ShaderMaterial *shader_material = Object::cast_to<ShaderMaterial>(object); doc_tooltip_text = "property|" + p.class_name + "|" + property_prefix + propname;
if (shader_material) {
doc_tooltip_text = "property|" + shader_material->get_shader()->get_path() + "|" + propname;
}
} else if (p.usage & PROPERTY_USAGE_INTERNAL) { } else if (p.usage & PROPERTY_USAGE_INTERNAL) {
doc_tooltip_text = "internal_property|" + classname + "|" + propname; doc_tooltip_text = "internal_property|" + classname + "|" + propname;
} else { } else {

16
scene/resources/shader.cpp
View File

@@ -156,8 +156,12 @@ void Shader::get_shader_uniform_list(List<PropertyInfo> *p_params, bool p_get_gr
#ifdef TOOLS_ENABLED #ifdef TOOLS_ENABLED
DocData::ClassDoc class_doc; DocData::ClassDoc class_doc;
class_doc.name = get_path(); bool generate_doc = Engine::get_singleton()->is_editor_hint() && !get_path().is_empty();
if (generate_doc) {
class_doc.name = get_path().trim_prefix("res://").quote();
class_doc.is_script_doc = true; class_doc.is_script_doc = true;
class_doc.inherits = "Shader";
}
#endif #endif
for (PropertyInfo &pi : local) { for (PropertyInfo &pi : local) {
@@ -176,10 +180,9 @@ void Shader::get_shader_uniform_list(List<PropertyInfo> *p_params, bool p_get_gr
pi.type = Variant::OBJECT; pi.type = Variant::OBJECT;
} }
#ifdef TOOLS_ENABLED #ifdef TOOLS_ENABLED
if (Engine::get_singleton()->is_editor_hint()) { if (generate_doc) {
DocData::PropertyDoc prop_doc; DocData::PropertyDoc prop_doc;
prop_doc.name = "shader_parameter/" + pi.name; prop_doc.name = "shader_parameter/" + pi.name;
#ifdef MODULE_REGEX_ENABLED
const RegEx pattern("/\\*\\*\\s([^*]|[\\r\\n]|(\\*+([^*/]|[\\r\\n])))*\\*+/\\s*uniform\\s+\\w+\\s+" + pi.name + "(?=[\\s:;=])"); const RegEx pattern("/\\*\\*\\s([^*]|[\\r\\n]|(\\*+([^*/]|[\\r\\n])))*\\*+/\\s*uniform\\s+\\w+\\s+" + pi.name + "(?=[\\s:;=])");
Ref<RegExMatch> pattern_ref = pattern.search(code); Ref<RegExMatch> pattern_ref = pattern.search(code);
if (pattern_ref.is_valid()) { if (pattern_ref.is_valid()) {
@@ -189,16 +192,17 @@ void Shader::get_shader_uniform_list(List<PropertyInfo> *p_params, bool p_get_gr
RegExMatch *match_tip = pattern_tip_ref.ptr(); RegExMatch *match_tip = pattern_tip_ref.ptr();
const RegEx pattern_stripped("\\n\\s*\\*\\s*"); const RegEx pattern_stripped("\\n\\s*\\*\\s*");
prop_doc.description = pattern_stripped.sub(match_tip->get_string(1), "\n", true); prop_doc.description = pattern_stripped.sub(match_tip->get_string(1), "\n", true);
}
#endif pi.class_name = class_doc.name;
class_doc.properties.push_back(prop_doc); class_doc.properties.push_back(prop_doc);
} }
}
#endif #endif
p_params->push_back(pi); p_params->push_back(pi);
} }
} }
#ifdef TOOLS_ENABLED #ifdef TOOLS_ENABLED
if (Engine::get_singleton()->is_editor_hint() && !class_doc.name.is_empty() && p_params) { if (generate_doc && class_doc.properties.size() > 0) {
EditorHelp::add_doc(class_doc); EditorHelp::add_doc(class_doc);
} }
#endif #endif