From: zrinka <zrinka>
Date: Fri, 2 Dec 2005 09:24:21 +0000 (+0000)
Subject: source documentation for ipv4.tcl
X-Git-Url: https://git.entuzijast.net/?a=commitdiff_plain;h=5ef9483d827bbf0a0ab091a96f90679fa3ee688e;p=imunes.git

source documentation for ipv4.tcl

Bug found by:
Submitted by:
Requested by:
Reviewed by:
Approved by:
Obtained from:
---

diff --git a/ipv4.tcl b/ipv4.tcl
index e88ec5c..c8c6c86 100755
--- a/ipv4.tcl
+++ b/ipv4.tcl
@@ -33,6 +33,10 @@
 # and Technology through the research contract #IP-2003-143.
 #
 
+#****h* imunes/ipv4.tcl
+# NAME
+#   ipv4.tcl -- file for handeling IPv4
+#****
 
 #****f* ipv4.tcl/findFreeIPv4Net
 # NAME
@@ -43,9 +47,9 @@
 #   Finds a free IPv4 network. Network is concidered to be free
 #   if there are no simulated nodes attached to it. 
 # INPUTS
-#   mask - this parameter is left unused for now
+#   * mask -- this parameter is left unused for now
 # RESULT
-#   ipnet - returns the free IPv4 network address in the form 10.a.b 
+#   * ipnet -- returns the free IPv4 network address in the form 10.a.b 
 #****
  
 proc findFreeIPv4Net { mask } {
@@ -79,10 +83,10 @@ proc findFreeIPv4Net { mask } {
 #   automaticaly assignes an IPv4 address to the interface $iface of 
 #   of the node $node  
 # INPUTS
-#   node  - the node containing the interface to witch a new 
-#           IPv4 address should be assigned
-#   iface - the interface to witch a new, automatilacy generated, IPv4  
-#           address will be assigned
+#   * node -- the node containing the interface to witch a new 
+#     IPv4 address should be assigned
+#   * iface -- the interface to witch a new, automatilacy generated, IPv4  
+#     address will be assigned
 #****
 
 proc autoIPv4addr { node iface } {
@@ -151,8 +155,8 @@ proc autoIPv4addr { node iface } {
 #   searches the interface of the node for a router, if a router is found
 #   then it is a new default gateway. 
 # INPUTS
-#   node  - default gateway is provided for this node 
-#   iface - the interface on witch we search for a new default gateway
+#   * node  -- default gateway is provided for this node 
+#   * iface -- the interface on witch we search for a new default gateway
 #****
 
 proc autoIPv4defaultroute { node iface } {
@@ -205,11 +209,11 @@ proc autoIPv4defaultroute { node iface } {
 # FUNCTION
 #   Checks if the provided string is a valid IPv4 address. 
 # INPUTS
-#   str - string to be evaluated. Valid IPv4 address is writen in form
-#         a.b.c.d 
+#   * str -- string to be evaluated. Valid IPv4 address is writen in form
+#     a.b.c.d 
 # RESULT
-#   valid - function returns 0 if the input string is not in the form
-#           of a valid IP address, 1 otherwise
+#   * valid -- function returns 0 if the input string is not in the form
+#     of a valid IP address, 1 otherwise
 #****
 
 proc checkIPv4Addr { str } {
@@ -248,10 +252,10 @@ proc checkIPv4Addr { str } {
 # FUNCTION
 #   Checks if the provided string is a valid IPv4 network. 
 # INPUTS
-#   str - string to be evaluated. Valid string is in form a.b.c.d/m 
+#   * str -- string to be evaluated. Valid string is in form a.b.c.d/m 
 # RESULT
-#   valid - function returns 0 if the input string is not in the form
-#           of a valid IP address, 1 otherwise
+#   * valid -- function returns 0 if the input string is not in the form
+#     of a valid IP address, 1 otherwise
 #****
 
 proc checkIPv4Net { str } {