From eccd78b5a270578b3e5af5e0a22fe64874e484a0 Mon Sep 17 00:00:00 2001
From: Doma <leishenghao@126.com>
Date: Tue, 20 Feb 2024 17:00:34 +0800
Subject: [PATCH] refactor: add @deprecated annotation to deprecated functions

---
 src/index.ts | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/src/index.ts b/src/index.ts
index 1f1d04df..dfd19181 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -29,20 +29,32 @@ import { startProfiling as _startProfiling } from './profiling';
 export { start, stop } from './start';
 export { listEnvVars } from './utils';
 
+/**
+ * @deprecated Use generic start() function instead
+ */
 export const startMetrics = deprecate(
   _startMetrics,
   'startMetrics is deprecated. Use generic start() and stop() functions instead'
 );
 
+/**
+ * @deprecated Use generic start() function instead
+ */
 export const startProfiling = deprecate(
   _startProfiling,
   'startProfiling is deprecated. Use generic start() and stop() functions instead'
 );
 
+/**
+ * @deprecated Use generic start() function instead
+ */
 export const startTracing = deprecate(
   _startTracing,
   'startTracing is deprecated. Use generic start() and stop() functions instead'
 );
+/**
+ * @deprecated Use generic stop() function instead
+ */
 export const stopTracing = deprecate(
   _stopTracing,
   'stopTracing is deprecated. Use generic start() and stop() functions instead'