documented CPE API

savon-noir · savon-noir · commit e73757eb6c42 · 2014-05-26T23:49:54.000+02:00
diff --git a/libnmap/objects/cpe.py b/libnmap/objects/cpe.py
@@ -28,31 +28,61 @@ def __repr__(self):
         return self._cpestring
 
     def get_part(self):
+        """
+            Returns the cpe part (/o, /h, /a)
+        """
         return self._cpedict['part']
 
     def get_vendor(self):
+        """
+            Returns the vendor name
+        """
         return self._cpedict['vendor']
 
     def get_product(self):
+        """
+            Returns the product name
+        """
         return self._cpedict['product']
 
     def get_version(self):
+        """
+            Returns the version of the cpe
+        """
         return self._cpedict['version']
 
     def get_update(self):
+        """
+            Returns the update version
+        """
         return self._cpedict['update']
 
     def get_edition(self):
+        """
+            Returns the cpe edition
+        """
         return self._cpedict['edition']
 
     def get_language(self):
+        """
+            Returns the cpe language
+        """
         return self._cpedict['language']
 
     def is_application(self):
+        """
+            Returns True if cpe describes an application
+        """
         return (self.get_part() == '/a')
 
     def is_hardware(self):
+        """
+            Returns True if cpe describes a hardware
+        """
         return (self.get_part() == '/h')
 
     def is_operating_system(self):
+        """
+            Returns True if cpe describes an operating system
+        """
         return (self.get_part() == '/o')
diff --git a/libnmap/objects/os.py b/libnmap/objects/os.py
@@ -1,6 +1,7 @@
 import warnings
 from libnmap.objects.cpe import CPE
 
+
 class OSFPPortUsed(object):
     """
         Port used class: this enables the user of NmapOSFingerprint class
