about summary refs log tree commit diff stats
path: root/html/000organization.cc.html
diff options
context:
space:
mode:
authorKartik K. Agaram <vc@akkartik.com>2016-09-10 10:43:19 -0700
committerKartik K. Agaram <vc@akkartik.com>2016-09-10 10:43:19 -0700
commit44c1aeef226542d692f0002b5cca5a3c30935d18 (patch)
tree46452902ff779d93e4adcb57cda29d923766a5be /html/000organization.cc.html
parentc7db6a160a9a43d0905d5dea44e742b47acfa42f (diff)
downloadmu-44c1aeef226542d692f0002b5cca5a3c30935d18.tar.gz
3315
Diffstat (limited to 'html/000organization.cc.html')
-rw-r--r--html/000organization.cc.html15
1 files changed, 14 insertions, 1 deletions
diff --git a/html/000organization.cc.html b/html/000organization.cc.html
index d34e80f2..35282386 100644
--- a/html/000organization.cc.html
+++ b/html/000organization.cc.html
@@ -126,10 +126,20 @@ body { font-size: 12pt; font-family: monospace; color: #eeeeee; background-color
 <span class="Comment">// Types</span>
 <span class="Comment">// End Types</span>
 
-<span class="Comment">// prototypes are auto-generated in the makefile; define your functions in any order</span>
+<span class="Comment">// Prototypes are auto-generated in the makefile; define your functions in any</span>
+<span class="Comment">// order. Just be sure to declare each function header all on one line. Our</span>
+<span class="Comment">// auto-generation scripts are too minimal and simple-minded to handle</span>
+<span class="Comment">// anything else.</span>
 <span class="PreProc">#include </span><span class="Constant">&quot;function_list&quot;</span>  <span class="Comment">// by convention, files ending with '_list' are auto-generated</span>
 
 <span class="Comment">// Globals</span>
+<span class="Comment">//</span>
+<span class="Comment">// All statements in this section should always define a single variable on a</span>
+<span class="Comment">// single line. The makefile will simple-mindedly auto-generate extern</span>
+<span class="Comment">// declarations for them. Don't forget to define (not just declare) constants</span>
+<span class="Comment">// with extern linkage in this section, since C++ global constants have</span>
+<span class="Comment">// internal linkage by default.</span>
+<span class="Comment">//</span>
 <span class="Comment">// End Globals</span>
 
 <span class="Normal">int</span> main<span class="Delimiter">(</span><span class="Normal">int</span> argc<span class="Delimiter">,</span> <span class="Normal">char</span>* argv[]<span class="Delimiter">)</span> <span class="Delimiter">{</span>
@@ -143,6 +153,9 @@ body { font-size: 12pt; font-family: monospace; color: #eeeeee; background-color
   <span class="Identifier">return</span> <span class="Constant">0</span><span class="Delimiter">;</span>  <span class="Comment">// End Main</span>
 <span class="Delimiter">}</span>
 
+<span class="Comment">// Unit Tests</span>
+<span class="Comment">// End Unit Tests</span>
+
 <span class="Comment">//: our first directive; will move the include above the program</span>
 <span class="Delimiter">:(before &quot;End Includes&quot;)</span>
 <span class="PreProc">#include </span><span class="Constant">&lt;stdlib.h&gt;</span>