From: Eduardo San Martin Morote <posva13@gmail.com>
Date: Fri, 10 Jun 2022 09:29:36 +0000 (+0200)
Subject: chore: doc function
X-Git-Tag: v4.1.0~37
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=728b5649439e3bb65f92f4d3b7cbf83710f39b82;p=thirdparty%2Fvuejs%2Frouter.git

chore: doc function
---

diff --git a/packages/router/src/devtools.ts b/packages/router/src/devtools.ts
index ea20cdca..c135a85b 100644
--- a/packages/router/src/devtools.ts
+++ b/packages/router/src/devtools.ts
@@ -19,6 +19,13 @@ import { RouterViewDevtoolsContext } from './RouterView'
 import { RouteLocationNormalized } from './types'
 import { assign, isArray } from './utils'
 
+/**
+ * Copies a route location and removes any problematic properties that cannot be shown in devtools (e.g. Vue instances).
+ *
+ * @param routeLocation - routeLocation to format
+ * @param tooltip - optional tooltip
+ * @returns a copy of the routeLocation
+ */
 function formatRouteLocation(
   routeLocation: RouteLocationNormalized,
   tooltip?: string