Documentation update

[git-p4: depot-paths = "//src/UPnP-IGD/dev/": change = 4031]
seattlerb · Jun 30, 2008 · 4463038 · 4463038
1 parent a7fa994
commit 4463038
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 3 deletions.
diff --git a/README.txt b/README.txt
@@ -14,6 +14,7 @@ A UPnP extension for Internet Gateway Devices
 * Command-line utility that displays information about a UPnP gateway
 * Example of using some UPnP APIs
 * Does not set anything on the device
+* Only tested against miniupnpd
 
 == SYNOPSIS:
 

diff --git a/lib/UPnP/control/device/internet_gateway_device.rb b/lib/UPnP/control/device/internet_gateway_device.rb
@@ -4,8 +4,20 @@
 require 'UPnP/control/service/wan_ip_connection'
 require 'UPnP/control/service/wan_common_interface_config'
 
+##
+# A UPnP Internet Gateway Device control point that provides friendly
+# accessors to its component services and provides a handy method to dump
+# information about the device.
+#
+# http://www.upnp.org/standardizeddcps/igd.asp
+
 class UPnP::Control::Device::InternetGatewayDevice < UPnP::Control::Device
 
+  ##
+  # The version of UPnP-IGD you are using
+
+  VERSION = '1.0.0'
+
   ##
   # Version 1 URN for InternetGatewayDevice
 

diff --git a/lib/UPnP/control/service/layer_3_forwarding.rb b/lib/UPnP/control/service/layer_3_forwarding.rb
@@ -1,10 +1,14 @@
 require 'rubygems'
 require 'UPnP/control/service'
 
+##
+# The UPnP Layer 3 Forwarding service models layer-3 packet forwarding
+# services for a WANDevice.
+
 class UPnP::Control::Service::Layer3Forwarding < UPnP::Control::Service
 
   ##
-  # Version 1 URN for Layer3Forwarding service
+  # Version 1 URN for the Layer3Forwarding service
 
   URN_1 = [UPnP::SERVICE_SCHEMA_PREFIX, name.split(':').last, 1].join ':'
 

diff --git a/lib/UPnP/control/service/wan_common_interface_config.rb b/lib/UPnP/control/service/wan_common_interface_config.rb
@@ -1,10 +1,14 @@
 require 'rubygems'
 require 'UPnP/control/service'
 
+##
+# A UPnP WAN Common Interface Config service models the physical layer
+# properties of a WAN interface on an InternetGatewayDevice.
+
 class UPnP::Control::Service::WANCommonInterfaceConfig < UPnP::Control::Service
 
   ##
-  # Version 1 URN for WANCommonInterfaceConfig service
+  # Version 1 URN for the WANCommonInterfaceConfig service
 
   URN_1 = [UPnP::SERVICE_SCHEMA_PREFIX, name.split(':').last, 1].join ':'
 

diff --git a/lib/UPnP/control/service/wan_ip_connection.rb b/lib/UPnP/control/service/wan_ip_connection.rb
@@ -1,10 +1,16 @@
 require 'rubygems'
 require 'UPnP/control/service'
 
+##
+# The UPnP WAN IP Connection service.
+#
+# This service is used to configure and control IP connections on the WAN
+# device of an InternetGatewayDevice.
+
 class UPnP::Control::Service::WANIPConnection < UPnP::Control::Service
 
   ##
-  # Version 1 URN for WANIPConnection
+  # Version 1 URN for the WANIPConnection
 
   URN_1 = [UPnP::SERVICE_SCHEMA_PREFIX, name.split(':').last, 1].join ':'