rubberduck-vba / RubberduckWeb

Project Website for the Rubberduck VBA Editor Add-In
19 stars 12 forks source link

Inspection Details fixes #72

Closed retailcoder closed 5 years ago

retailcoder commented 5 years ago

These changes make the the inspection xml-docs much more flexible.

Inspection examples that need multiple modules can now do this:

<example hasresult="true">
<module name="Module1" type="Standard">
<![CDATA[
Option Explicit
...
]]>
</module>
<module name="Class1" type="Class">
<![CDATA[
Option Explicit
...
]]>
</module>
</example>

Otherwise, the CDATA code block can also remain directly under the <example> tag. Although theoretically supported, inspection xml-doc examples should either all use a <module> tag, or none of them should.

No need for a <module> tag if the module type is irrelevant or if there's only one module, however when the example is only applicable in a specific module type, consider including a <module> tag with a e.g. type="Class" attribute, even if there's only one single module involved.

Now, does anyone knows enough CSS to make the module name & type look pretty?