From 9e282f0389f0740d2114bf5d4f47f45809c503ef Mon Sep 17 00:00:00 2001 From: Oscar Beaumont Date: Thu, 1 Aug 2024 20:48:32 +0800 Subject: [PATCH] minor doc fixes --- specta-jsdoc/src/lib.rs | 4 ++-- specta-typescript/src/lib.rs | 8 ++++---- specta-typescript/src/typescript.rs | 10 +++++----- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/specta-jsdoc/src/lib.rs b/specta-jsdoc/src/lib.rs index 2b9868b..3f90048 100644 --- a/specta-jsdoc/src/lib.rs +++ b/specta-jsdoc/src/lib.rs @@ -52,9 +52,9 @@ impl JSDoc { /// Configure a function which is responsible for styling the comments to be exported /// /// Implementations: - /// - [`js_doc`](crate::lang::ts::js_doc) + /// - [`js_doc`](specta_typescript::lang::ts::js_doc) /// - /// Not calling this method will default to the [`js_doc`](crate::lang::ts::js_doc) exporter. + /// Not calling this method will default to the [`js_doc`](specta_typescript::lang::ts::js_doc) exporter. /// `None` will disable comment exporting. /// `Some(exporter)` will enable comment exporting using the provided exporter. pub fn comment_style(mut self, exporter: CommentFormatterFn) -> Self { diff --git a/specta-typescript/src/lib.rs b/specta-typescript/src/lib.rs index 1e02ed8..5ba898c 100644 --- a/specta-typescript/src/lib.rs +++ b/specta-typescript/src/lib.rs @@ -36,14 +36,14 @@ pub type Result = std::result::Result; pub(crate) type Output = Result; -/// Convert a type which implements [`Type`](crate::Type) to a TypeScript string with an export. +/// Convert a type which implements [`Type`] to a TypeScript string with an export. /// /// Eg. `export type Foo = { demo: string; };` pub fn export_ref(_: &T, conf: &Typescript) -> Output { export::(conf) } -/// Convert a type which implements [`Type`](crate::Type) to a TypeScript string with an export. +/// Convert a type which implements [`Type`] to a TypeScript string with an export. /// /// Eg. `export type Foo = { demo: string; };` pub fn export(conf: &Typescript) -> Output { @@ -59,14 +59,14 @@ pub fn export(conf: &Typescript) -> Output { result } -/// Convert a type which implements [`Type`](crate::Type) to a TypeScript string. +/// Convert a type which implements [`Type`] to a TypeScript string. /// /// Eg. `{ demo: string; };` pub fn inline_ref(_: &T, conf: &Typescript) -> Output { inline::(conf) } -/// Convert a type which implements [`Type`](crate::Type) to a TypeScript string. +/// Convert a type which implements [`Type`] to a TypeScript string. /// /// Eg. `{ demo: string; };` pub fn inline(conf: &Typescript) -> Output { diff --git a/specta-typescript/src/typescript.rs b/specta-typescript/src/typescript.rs index 9518891..1cb1839 100644 --- a/specta-typescript/src/typescript.rs +++ b/specta-typescript/src/typescript.rs @@ -106,9 +106,9 @@ impl Typescript { /// Configure a function which is responsible for styling the comments to be exported /// /// Implementations: - /// - [`js_doc`](crate::lang::ts::js_doc) + /// - [`js_doc`](specta_typescript::js_doc) /// - /// Not calling this method will default to the [`js_doc`](crate::lang::ts::js_doc) exporter. + /// Not calling this method will default to the [`js_doc`](specta_typescript::js_doc) exporter. /// `None` will disable comment exporting. /// `Some(exporter)` will enable comment exporting using the provided exporter. pub fn comment_style(mut self, exporter: CommentFormatterFn) -> Self { @@ -120,9 +120,9 @@ impl Typescript { /// /// /// Built-in implementations: - /// - [`prettier`](specta_typescript:formatter:::prettier) - /// - [`ESLint`](specta_typescript::formatter::eslint) - /// - [`Biome`](specta_typescript::formatter::biome)e + /// - [`prettier`](crate:formatter:::prettier) + /// - [`ESLint`](crate::formatter::eslint) + /// - [`Biome`](crate::formatter::biome)e pub fn formatter(mut self, formatter: FormatterFn) -> Self { self.formatter = Some(formatter); self