search

timo-sisus / Power-Inspector

Report bugs and offer improvement ideas for Power Inspector.
http://u3d.as/1sNc
8 stars 0 forks source link

XML Comment Tooltips omit attribute value strings for common attribute types #34

Closed adreyer-tpci closed 2 years ago

adreyer-tpci commented 2 years ago

When a class, parameter, or type parameter reference is embedded in an XML header comment, the auto-generated XML tooltip that appears in PowerInspector omits the contents of the attribute value entirely. The absence of important inline class or method names present in these comments makes them impossible to understand without inspecting the source script.

For example, observe how the XML comment for someScalerValue appears in JetBrains Rider's Documentation panel:

rider_xml_header_source

Versus how it appears in PowerInspector's tooltip window, where the "SomeUtilityClass" and "PrintScalerValue" strings are missing:

powerinspector_xml_missing_string

This is the case for all XML attributes with embedded attribute values, including:

At least printing the contents of any cref or name attribute value would help considerably.

timo-sisus commented 2 years ago

The inner texts of the cref and name tags will be included in tooltip texts in Power Inspector version 1.6.6.

The new version has been submitted to the asset store for approval - which usually takes around a day or so.