kmx.io/prism.js/examples/prism-jsdoc.html

Branch - branch -master

• Show log

  Commit

• Hash : 3e181241
  Author :
  Date : 2019-06-12T15:28:44
  

  Added more examples & small TOML improvement (#1917) This adds some of the missing examples and makes a small improvement to TOML.

Download

• examples/prism-jsdoc.html

• <h2>Full example</h2>
  <pre><code class="language-javascript">/**
   * @typedef {object} Foo
   * @property {string} bar
   * @memberof Baz
   */
  
  /**
   * Trims the given string.
   *
   * @param {string} [str=""] the string.
   * @returns {string} the trimmed string.
   * @throws {TypeError} if the argument is not a string.
   * @example trim(" hello ")
   */
  function trim(str = "") {
  	if (typeof str != "string") {
  		throw new TypeError("str has to be a string");
  	}
  	return str.trim();
  }</code></pre>
  

Download