filled out @namespace

mathematicalcoffee · mathematicalcoffee · commit e486be0ee3d4 · 2013-02-05T13:24:15.000+10:00
diff --git a/Jake/articles/tags-namespace b/Jake/articles/tags-namespace
@@ -1,24 +1,41 @@
 <!--{
     "title":       "@namespace",
     "out":         "tags-namespace.html",
-    "description": "[todo] Document a namespace object."
+    "description": "Document a namespace object."
 }-->
+<h3>Syntax</h3>
+
+<code>@namespace [&lt;SomeName&gt;]</code>
+
 <h3>Overview</h3>
 
 <p>
+The @namespace tag marks an object as being a namespace.
 </p>
 
 <h3>Examples</h3>
 
-<p>
-</p>
+{{#example}}Defining a namespace as an object.
+/** A namespace.
+ * @namespace */
+var MyNamespace = {
+    /** MyNamespace.foo */
+    foo: function () {},
+    /** MyNamespace.bar */
+    bar: 1
+};
+{{/example}}
 
-{{#example}}Example goes here
-// todo
+{{#example}}Defining a namespace virtually.
+/** A namespace.
+ * @namespace MyNamespace */
+/** A function in MyNamespace (MyNamespace.myFunction)
+ * @function myFunction
+ * @memberof MyNamespace */
 {{/example}}
 
 <h3>See Also</h3>
 
 <ul>
-    <li><a href="#">...</a></li>
-</ul>
+    <li><a href="tags-module.html">@module</a></li>
+</ul>
diff --git a/index.html b/index.html
@@ -295,7 +295,7 @@ <h2 name="JSDoc3_Tag_Dictionary" id="JSDoc3_Tag_Dictionary">JSDoc 3 Tag Dictiona
 		<dd>Describe the object.</dd>	<dt><a href="tags-instance.html">@instance</a></dt>
 		<dd>Document an instance member.</dd>	<dt><a href="tags-name.html">@name</a></dt>
 		<dd>[todo] Document the name of an object.</dd>	<dt><a href="tags-namespace.html">@namespace</a></dt>
-		<dd>[todo] Document a namespace object.</dd>	<dt><a href="tags-enum.html">@enum</a></dt>
+		<dd>Document a namespace object.</dd>	<dt><a href="tags-enum.html">@enum</a></dt>
 		<dd>Document a collection of related properties.</dd>	<dt><a href="tags-default.html">@default</a></dt>
 		<dd>Document the default value.</dd>	<dt><a href="tags-private.html">@private</a></dt>
 		<dd>This member is meant to be private.</dd>	<dt><a href="tags-method.html">@method</a></dt>
diff --git a/tags-namespace.html b/tags-namespace.html
@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
 	<meta charset="utf-8">
-	<meta name="description" content="[todo] Document a namespace object."><title>Use JSDoc: @namespace</title>
+	<meta name="description" content="Document a namespace object."><title>Use JSDoc: @namespace</title>
 	
 	<link rel="stylesheet" href="lib/prettify.css" />
 	<script src="lib/prettify.js"></script>
@@ -176,29 +176,51 @@
 	<article>
 	<h1>@namespace</h1>
 
+<h3>Syntax</h3>
+
+<code>@namespace [&lt;SomeName&gt;]</code>
+
 <h3>Overview</h3>
 
 <p>
+The @namespace tag marks an object as being a namespace.
 </p>
 
 <h3>Examples</h3>
 
-<p>
-</p>
-
 <dl class="example">
-<dt>Example goes here</dt>
+<dt>Defining a namespace as an object.</dt>
 <dd>
 <pre class="prettyprint lang-js">
-// todo
+/** A namespace.
+ * @namespace */
+var MyNamespace = {
+    /** MyNamespace.foo */
+    foo: function () {},
+    /** MyNamespace.bar */
+    bar: 1
+};
+
+</pre>
+</dd>
+</dl><dl class="example">
+<dt>Defining a namespace virtually.</dt>
+<dd>
+<pre class="prettyprint lang-js">
+/** A namespace.
+ * @namespace MyNamespace */
+/** A function in MyNamespace (MyNamespace.myFunction)
+ * @function myFunction
+ * @memberof MyNamespace */
 
 </pre>
 </dd>
 </dl><h3>See Also</h3>
 
 <ul>
-    <li><a href="#">...</a></li>
-</ul>
+    <li><a href="tags-module.html">@module</a></li>
+</ul>
+
     </article>
     
     <footer>
