From 78701ecb78decaa1c0b1ed2332fdc6cce6be00aa Mon Sep 17 00:00:00 2001 From: "Rico Sta. Cruz" Date: Sun, 29 Oct 2017 20:04:52 +0800 Subject: [PATCH] jsdoc: update --- jsdoc.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/jsdoc.md b/jsdoc.md index fcb9d9e87..3025eb778 100644 --- a/jsdoc.md +++ b/jsdoc.md @@ -1,9 +1,12 @@ --- title: Jsdoc category: JavaScript +layout: 2017/sheet +updated: 2017-10-29 +weight: -1 --- -## Functions +### Functions ```js /* @@ -22,9 +25,9 @@ category: JavaScript function foo(n) { return n } ``` -See: http://usejsdoc.org/index.html +See: -## Types +### Types ``` /** @@ -38,16 +41,18 @@ See: http://usejsdoc.org/index.html */ ``` -See: http://usejsdoc.org/tags-type.html +See: -## Variables +### Variables ```js /** * @type {number} */ var FOO = 1 +``` +```js /** * @const {number} */ @@ -64,7 +69,9 @@ const FOO = 1 * @property {string} artist - The artist * @property {number} year - The year */ +``` +```js /** * Plays a song * @param {Song} song - The {@link Song} to be played @@ -74,9 +81,9 @@ function play (song) { } ``` -See: http://usejsdoc.org/tags-typedef.html +See: -## Renaming +### Renaming ```js /* @@ -85,4 +92,4 @@ See: http://usejsdoc.org/tags-typedef.html */ ``` -Prefer `alias` over `name`. See: http://usejsdoc.org/tags-alias.html +Prefer `alias` over `name`. See: