From 7322908334fb2b91a7947a6779a249a4a7d271ad Mon Sep 17 00:00:00 2001
From: Mitch Watrous <watrous@u.washington.edu>
Date: Thu, 5 May 2011 10:36:26 -0700
Subject: [PATCH] Improve comments for template module

---
 src/template/examples/wscript |  9 +++++++++
 src/template/wscript          | 16 ++++++++++++++++
 2 files changed, 25 insertions(+)

diff --git a/src/template/examples/wscript b/src/template/examples/wscript
index 7f2f3ccf4..553eab577 100644
--- a/src/template/examples/wscript
+++ b/src/template/examples/wscript
@@ -1,5 +1,14 @@
 ## -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
 
 def build(bld):
+    # Don't build any examples unless they are enabled.
     if not bld.env['ENABLE_EXAMPLES']:
         return;
+
+    # Uncomment these lines to build this C++ example program.
+    #program = bld.create_ns3_program('sample-example', ['core'])
+    #program.source = 'sample-example.cc'
+
+    # Uncomment this line to register the dependencies for this Python
+    # example script.
+    #bld.register_ns3_script('sample-example.py', ['core'])
diff --git a/src/template/wscript b/src/template/wscript
index b48414c46..0c1bfd06e 100644
--- a/src/template/wscript
+++ b/src/template/wscript
@@ -1,19 +1,35 @@
 ## -*- Mode: python; py-indent-offset: 4; indent-tabs-mode: nil; coding: utf-8; -*-
 
 def build(bld):
+    # Create the module with the appropriate name and the list of
+    # modules it depends on.
     module = bld.create_ns3_module('template', ['core'])
+
+    # Set the C++ source files for this module.
     module.source = [
         ]
 
+    # Create the module's test library.
     test_library = bld.create_ns3_module_test_library('template')
+
+    # Set the C++ source files for the module's test library.
     test_library.source = [
         'test/sample-test-suite.cc',
         ]
 
+    # Make headers be installed for this module.
     headers = bld.new_task_gen('ns3header')
     headers.module = 'template'
+
+    # Set the C++ header files for this module.
     headers.source = [
         ]
 
+    # Uncomment these lines if this module needs a library such as the
+    # real-time (RT) library to be linked in at build time.
+    #module      .uselib = 'RT'
+    #test_library.uselib = 'RT'
+
+    # Look for examples if they are enabled. 
     if (bld.env['ENABLE_EXAMPLES']):
         bld.add_subdirs('examples')