docs: fix invalid jsdoc comments (#10241)

vitejs · Sep 25, 2022 · 9acb839 · 9acb839
1 parent 71eaacf
commit 9acb839
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/packages/vite/src/node/config.ts b/packages/vite/src/node/config.ts
@@ -126,7 +126,7 @@ export interface UserConfig {
  /**
  * Directory to serve as plain static assets. Files in this directory are
  * served and copied to build dist dir as-is without transform. The value
- * can be either an absolute file system path or a path relative to <root>.
+ * can be either an absolute file system path or a path relative to project root.
  *
  * Set to `false` or an empty string to disable copied static assets to build dist dir.
  * @default 'public'
@@ -137,7 +137,7 @@ export interface UserConfig {
  * deps or some other cache files that generated by vite, which can improve
  * the performance. You can use `--force` flag or manually delete the directory
  * to regenerate the cache files. The value can be either an absolute file
- * system path or a path relative to <root>.
+ * system path or a path relative to project root.
  * Default to `.vite` when no `package.json` is detected.
  * @default 'node_modules/.vite'
  */

diff --git a/packages/vite/src/node/plugin.ts b/packages/vite/src/node/plugin.ts
@@ -108,7 +108,7 @@ export interface Plugin extends RollupPlugin {
  * - bundle?: rollup.OutputBundle (only present during build)
  *
  * It can either return a transformed string, or a list of html tag
- * descriptors that will be injected into the <head> or <body>.
+ * descriptors that will be injected into the `<head>` or `<body>`.
  *
  * By default the transform is applied **after** vite's internal html
  * transform. If you need to apply the transform before vite, use an object:

diff --git a/packages/vite/src/node/plugins/importAnalysis.ts b/packages/vite/src/node/plugins/importAnalysis.ts
@@ -147,7 +147,7 @@ function extractImportedBindings(
  * ```
  *
  * - CSS imports are appended with `.js` since both the js module and the actual
- * css (referenced via <link>) may go through the transform pipeline:
+ * css (referenced via `<link>`) may go through the transform pipeline:
  *
  * ```js
  * import './style.css'