[nautilus-python] Updated the FileInfo documentation to include some parameter/return type info



commit 20ef42d95537b855f06cf01815e7aad7451e770b
Author: Adam Plumb <adamplumb gmail com>
Date:   Thu Jan 14 11:44:49 2010 -0500

    Updated the FileInfo documentation to include some parameter/return type info

 examples/documentation.py |   52 +++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 52 insertions(+), 0 deletions(-)
---
diff --git a/examples/documentation.py b/examples/documentation.py
index 6682826..f09d5a1 100644
--- a/examples/documentation.py
+++ b/examples/documentation.py
@@ -93,54 +93,106 @@ class Column:
 
 class FileInfo:
     def is_gone(self):
+        """
+        @rtype   boolean
+        """
         pass
 
     def get_file_type(self):
+        """
+        @rtype   gio.GFileType
+        """
         pass
 
     def get_location(self):
+        """
+        @rtype   gio.GFile
+        """
         pass
 
     def get_name(self):
+        """
+        @rtype   string
+        """
         pass
 
     def get_uri(self):
+        """
+        @rtype   string
+        """
         pass
 
     def get_activation_uri(self):
+        """
+        @rtype   string
+        """
         pass
 
     def get_parent_location(self):
+        """
+        @rtype   gio.GFile
+        """
         pass
 
     def get_parent_uri(self):
+        """
+        @rtype   string
+        """
         pass
 
     def get_uri_scheme(self):
+        """
+        @rtype   string
+        """
         pass
 
     def get_mime_type(self):
+        """
+        @rtype   string
+        """
         pass
     
     def is_mime_type(self, mime_type):
+        """
+        @type   mime_type   string
+        @rtype  boolean
+        """
         pass
 
     def is_directory(self):
+        """
+        @rtype   boolean
+        """
         pass
     
     def can_write(self):
+        """
+        @rtype   boolean
+        """
         pass
 
     def add_emblem(self, emblem):
+        """
+        @rtype   void
+        """
         pass
     
     def get_string_attribute(self, attribute_name):
+        """
+        @rtype   string
+        """
         pass
 
     def add_string_attribute(self, attribute_name, value):
+        """
+        @rtype   void
+        """
         pass
 
     def invalidate_extension_info(self):
+        """
+        @rtype   void
+        """
         pass
     
 class PropertyPage:



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]