Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support @link [...](...) syntax for tsdoc link syntax #88

Open
MangelMaxime opened this issue May 13, 2024 · 0 comments
Open

Support @link [...](...) syntax for tsdoc link syntax #88

MangelMaxime opened this issue May 13, 2024 · 0 comments

Comments

@MangelMaxime
Copy link
Contributor

TypeScript documentation:

export interface CoreOptions {
    /**
     * Call this function to update the table state.
     * @link [API Docs](https://tanstack.com/table/v8/docs/api/core/table#setstate)
     * @link [Guide](https://tanstack.com/table/v8/docs/guide/tables)
     */
    setState: void;
}

translates into

module rec Glutinum

open Fable.Core
open Fable.Core.JsInterop
open System

[<AllowNullLiteral>]
[<Interface>]
type CoreOptions =
    /// <summary>
    /// Call this function to update the table state.
    /// <see href="https://tanstack.com/table/v8/docs/api/core/table#setstate">API Docs</see>"
    /// <see href="https://tanstack.com/table/v8/docs/guide/tables">Guide</see>"
    /// </summary>
    abstract member setState: unit with get, set

Example of npm package using this features:

TanStack/table

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant