documon
Version:
A documentation system for mortals. Use with any language.
89 lines (64 loc) • 2.7 kB
HTML
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Default Values</title>
<meta name="description" content="more.comment_authoring_guide.default_values">
<!-- Normalize -->
<link rel="stylesheet" href="assets/vendor/normalize.css">
<!-- prettify -->
<link rel="stylesheet" href="assets/vendor/prettify/codamike.css">
<script src="assets/vendor/prettify/prettify.js"></script>
<!-- Documon Pages Info. (Used by various classes to identify this page.) -->
<script>
var pageCtx = {
id : "more.comment_authoring_guide.default_values",
name: "Default Values"
}
</script>
<!-- theme
<link rel="stylesheet" href="assets/fonts/Fira_Sans/FiraSans.css">
<link rel="stylesheet" href="assets/fonts/Inconsolata/inconsolata.css">
-->
<link rel="stylesheet" href="assets/css/pages.css">
<script src="assets/js/documon/Storage.js"></script>
<script src="assets/js/documon/Access.js"></script>
<script src="assets/js/documon/Pages.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-106684927-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div class="page">
<div class="more"><h1 id="default-values">Default Values</h1>
<p>Use the <a href="https://github.com/default">@default</a>, <a href="https://github.com/defaultVal">@defaultVal</a> or <a href="https://github.com/defaultValue">@defaultValue</a> flags:</p>
<pre><code>@default Something
@defaultVal "foo"
@defaultValue 42</code></pre>
<p>In a property</p>
<pre><code>@property foo
@type object
@default "bar"</code></pre>
<h3 id="incorporate-a-default-value-inline">Incorporate a Default Value Inline</h3>
<p>Include the default value by attaching it to the name with an equal sign.</p>
<p>In a method param tag:</p>
<pre><code>@param {type} arg1=foo - description</code></pre>
<p>In a "quick prop" property:</p>
<pre><code>@property {object} foo="bar" - description</code></pre>
<p>The equal sign must butt-up against the name and the value:</p>
<dl>
<dt>good:</dt>
<dd><p>arg1=foo</p></dd>
<dt>bad:</dt>
<dd><p>arg1 = foo</p></dd>
</dl></div>
</div>
<div class="footer">Generated by <a href="http://www.documon.net" target="_blank">Documon</a></div>
</body>
</html>