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

Use TypeDoc to build documentation #12

Open
stijnklomp opened this issue Apr 19, 2023 · 3 comments
Open

Use TypeDoc to build documentation #12

stijnklomp opened this issue Apr 19, 2023 · 3 comments
Labels
feature New feature or request

Comments

@stijnklomp
Copy link
Member

stijnklomp commented Apr 19, 2023

@stijnklomp stijnklomp added the feature New feature or request label Apr 19, 2023
@stijnklomp
Copy link
Member Author

Discuss if this is necessary

@stijnklomp stijnklomp changed the title Code commented functions Use TypeDoc to help build documentation Apr 19, 2023
@stijnklomp stijnklomp changed the title Use TypeDoc to help build documentation Use TypeDoc to build documentation Apr 19, 2023
@stijnklomp
Copy link
Member Author

@stijnklomp stijnklomp added the adjustment Adjustment to an already existing feature label Apr 19, 2023
@stijnklomp
Copy link
Member Author

stijnklomp commented Apr 20, 2023

Example of Typescript + TypeDoc:

/**
 * Calculates the square root of a number.
 *
 * @param x the number to calculate the root of.
 * @returns the square root if `x` is non-negative or `NaN` if `x` is negative.
 */
export function sqrt(x: number): number {
    return Math.sqrt(x);
}

@stijnklomp stijnklomp removed the adjustment Adjustment to an already existing feature label Apr 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant