@salesforcedevs/docs-components 0.56.2-seo-test16 → 0.56.2-seo-test17

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@salesforcedevs/docs-components",
-    "version": "0.56.2-seo-test16",
+    "version": "0.56.2-seo-test17",
     "description": "Docs Lightning web components for DSC",
     "license": "MIT",
     "main": "index.js",

package/src/modules/doc/amfReference/amfReference.ts

@@ -482,6 +482,7 @@ export default class AmfReference extends LightningElement {
         parentReferencePath: string,
         meta: string
     ): string {
+        // update the encoded url meta param
         const encodedMeta = meta ? this.getUrlEncoded(meta) : "";
         return encodedMeta ? `${parentReferencePath}?meta=${encodedMeta}` : "";
     }
@@ -733,6 +734,7 @@ export default class AmfReference extends LightningElement {
         meta?: string
     ): void {
         if (meta) {
+            // update the encoded url meta param
             const encodedMeta = this.getUrlEncoded(meta);
             window.history.pushState(
                 {},
@@ -750,6 +752,7 @@ export default class AmfReference extends LightningElement {
         meta?: string
     ): void {
         if (meta) {
+            // update the encoded url meta param
             const encodedMeta = this.getUrlEncoded(meta);
             window.history.replaceState(
                 {},
@@ -878,7 +881,7 @@ export default class AmfReference extends LightningElement {
     }
 
     /**
-     * @returns meta query param from given Url
+     * Returns the decoded meta query param from given Url as it is being used internally.
      */
     getMetaFromUrl(referenceUrl: string): string {
         const indexOfQueryParam = referenceUrl.indexOf("?");
@@ -915,6 +918,9 @@ export default class AmfReference extends LightningElement {
 
     /**
      * Gets the encoded url.
+     * This method will return the encoded url for 2 cases,
+     * 1. If the url is encoded already
+     * 2. If the url is decoded
      */
     getUrlEncoded(url: string) {
         // if url matches, then return the encoded url.