diff options
author | Kitson Kelly <me@kitsonkelly.com> | 2018-10-15 07:29:50 +1100 |
---|---|---|
committer | Ryan Dahl <ry@tinyclouds.org> | 2018-10-14 17:38:23 -0400 |
commit | 10a97679ac80b4304c75d33cbc59c5736d11deb1 (patch) | |
tree | b51b9183ed251f61373069e5c4d35e39603bedb2 /js/symlink.ts | |
parent | 1840a1971317f5b8fc6e322b3a414b7f8a593c88 (diff) |
Align JSDoc to style guide.
Diffstat (limited to 'js/symlink.ts')
-rw-r--r-- | js/symlink.ts | 22 |
1 files changed, 10 insertions, 12 deletions
diff --git a/js/symlink.ts b/js/symlink.ts index 20232c2e5..0e633f138 100644 --- a/js/symlink.ts +++ b/js/symlink.ts @@ -4,13 +4,12 @@ import { flatbuffers } from "flatbuffers"; import * as dispatch from "./dispatch"; import * as util from "./util"; -/** - * Synchronously creates newname as a symbolic link to oldname. - * The type argument can be set to 'dir' or 'file' and is only - * available on Windows (ignored on other platforms). +/** Synchronously creates `newname` as a symbolic link to `oldname`. The type + * argument can be set to `dir` or `file` and is only available on Windows + * (ignored on other platforms). * - * import { symlinkSync } from "deno"; - * symlinkSync("old/name", "new/name"); + * import { symlinkSync } from "deno"; + * symlinkSync("old/name", "new/name"); */ export function symlinkSync( oldname: string, @@ -20,13 +19,12 @@ export function symlinkSync( dispatch.sendSync(...req(oldname, newname, type)); } -/** - * Creates newname as a symbolic link to oldname. - * The type argument can be set to 'dir' or 'file' and is only - * available on Windows (ignored on other platforms). +/** Creates `newname` as a symbolic link to `oldname`. The type argument can be + * set to `dir` or `file` and is only available on Windows (ignored on other + * platforms). * - * import { symlink } from "deno"; - * await symlink("old/name", "new/name"); + * import { symlink } from "deno"; + * await symlink("old/name", "new/name"); */ export async function symlink( oldname: string, |