io.extendreality.malimbe - npm Package Compare versions

Comparing version 5.1.0 to 5.2.0

CHANGELOG.md

 # Changelog
 
+# [5.2.0](https://github.com/ExtendRealityLtd/Malimbe/compare/v5.1.0...v5.2.0) (2019-01-13)
+
+
+### Features
+
+* **XmlToTooltip:** allow customizing the XML tag replacement ([3da2ae3](https://github.com/ExtendRealityLtd/Malimbe/commit/3da2ae3))
+
 # [5.1.0](https://github.com/ExtendRealityLtd/Malimbe/compare/v5.0.0...v5.1.0) (2019-01-12)
@@ -4,0 +11,0 @@

package.json

@@ -5,3 +5,3 @@ {
     "description": "A collection of tools to simplify writing public API components in Unity.",
-    "version": "5.1.0",
+    "version": "5.2.0",
     "unity": "2018.1",
@@ -8,0 +8,0 @@ "keywords": [

README.md

@@ -48,3 +48,3 @@ [![Malimbe logo][Malimbe-Image]](#)
       </Malimbe.ValidatePropertiesMethod>
-      <Malimbe.XmlDocumentationToFieldTooltip>
+      <Malimbe.XmlDocumentationToFieldTooltip IdentifierReplacementFormat="`{0}`">
         <NamespaceFilter>^My.Namespace.Example</NamespaceFilter>
@@ -106,2 +106,9 @@ </Malimbe.XmlDocumentationToFieldTooltip>
   * In case the attribute already exists on the field it will be replaced.
+  * Tags in the XML documentation comment like `<see cref="Something"/>` will be replaced by just the "identifier" `Something` by default. To customize this behavior the XML _attribute_ `IdentifierReplacementFormat` can be used, e.g.:
+    ```xml
+      <Malimbe.XmlDocumentationToFieldTooltip IdentifierReplacementFormat="`{0}`">
+        <NamespaceFilter>^My.Namespace.Example</NamespaceFilter>
+      </Malimbe.XmlDocumentationToFieldTooltip>
+    ```
+    The format needs to specify a placeholder `{0}`, otherwise an error will be logged and the default replacement format will be used instead.
 * `UnityPackaging`: Outputs a ready-to-use folder with the appropriate hierarchy to copy into a Unity project's Asset folder. The output includes both the Unity integration libraries as well as all weavers listed above.
@@ -108,0 +115,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

722870

increased by0.27%

Number of lines in readme file

158

increased by4.64%

No dependency changes