Pierre-Olivier Latour hace 11 años
padre
commit
519866bc03
Se han modificado 2 ficheros con 21 adiciones y 20 borrados
  1. 6 7
      GCDWebDAVServer/GCDWebDAVServer.h
  2. 15 13
      GCDWebUploader/GCDWebUploader.h

+ 6 - 7
GCDWebDAVServer/GCDWebDAVServer.h

@@ -71,8 +71,8 @@
 
 
 /**
 /**
  *  The GCDWebDAVServer subclass of GCDWebServer implements a class 1 compliant
  *  The GCDWebDAVServer subclass of GCDWebServer implements a class 1 compliant
- *  WebDAV server. It is also partially class 2 compliant (but only when the
- *  client is the OS X WebDAV implementation), so it can work with the OS X Finder.
+ *  WebDAV server. It is also partially class 2 compliant but only when the
+ *  client is the OS X WebDAV implementation (so it can work with the OS X Finder).
  *
  *
  *  See the README.md file for more information about the features of GCDWebDAVServer.
  *  See the README.md file for more information about the features of GCDWebDAVServer.
  */
  */
@@ -89,16 +89,15 @@
 @property(nonatomic, assign) id<GCDWebDAVServerDelegate> delegate;
 @property(nonatomic, assign) id<GCDWebDAVServerDelegate> delegate;
 
 
 /**
 /**
- *  Restricts which files should be listed and allowed to be uploaded, downloaded,
- *  moved, copied or deleted depending on their extensions.
+ *  Sets which files are allowed to be operated on depending on their extension.
  *
  *
  *  The default value is nil i.e. all file extensions are allowed.
  *  The default value is nil i.e. all file extensions are allowed.
  */
  */
 @property(nonatomic, copy) NSArray* allowedFileExtensions;
 @property(nonatomic, copy) NSArray* allowedFileExtensions;
 
 
 /**
 /**
- *  Sets if files and directories whose name start with a period should be
- *  listed and allowed to be uploaded, downloaded, moved, copied or deleted.
+ *  Sets if files and directories whose name start with a period are allowed to
+ *  be operated on.
  *
  *
  *  The default value is NO.
  *  The default value is NO.
  */
  */
@@ -119,7 +118,7 @@
 @interface GCDWebDAVServer (Subclassing)
 @interface GCDWebDAVServer (Subclassing)
 
 
 /**
 /**
- *  This method is called to check if a file is allowed to be uploaded.
+ *  This method is called to check if a file upload is allowed to complete.
  *  The uploaded file is available for inspection at "tempPath".
  *  The uploaded file is available for inspection at "tempPath".
  *
  *
  *  The default implementation returns YES.
  *  The default implementation returns YES.

+ 15 - 13
GCDWebUploader/GCDWebUploader.h

@@ -30,7 +30,7 @@
 @class GCDWebUploader;
 @class GCDWebUploader;
 
 
 /**
 /**
- *  Delegate methods for GCDWebUploaderDelegate.
+ *  Delegate methods for GCDWebUploader.
  *
  *
  *  @warning These methods are always called on the main thread in a serialized way.
  *  @warning These methods are always called on the main thread in a serialized way.
  */
  */
@@ -70,37 +70,39 @@
  *  or directories.
  *  or directories.
  *
  *
  *  See the README.md file for more information about the features of GCDWebUploader.
  *  See the README.md file for more information about the features of GCDWebUploader.
+ *
+ *  @warning For GCDWebUploader to work, "GCDWebUploader.bundle" must be added
+ *  to the resources of the Xcode target.
  */
  */
 @interface GCDWebUploader : GCDWebServer
 @interface GCDWebUploader : GCDWebServer
 
 
 /**
 /**
- *  Returns the upload directory as specified when the server was initialized.
+ *  Returns the upload directory as specified when the uploader was initialized.
  */
  */
 @property(nonatomic, readonly) NSString* uploadDirectory;
 @property(nonatomic, readonly) NSString* uploadDirectory;
 
 
 /**
 /**
- *  Sets the delegate for the server.
+ *  Sets the delegate for the uploader.
  */
  */
 @property(nonatomic, assign) id<GCDWebUploaderDelegate> delegate;
 @property(nonatomic, assign) id<GCDWebUploaderDelegate> delegate;
 
 
 /**
 /**
- *  Restricts which files should be listed and allowed to be uploaded, downloaded,
- *  moved or deleted depending on their extensions.
+ *  Sets which files are allowed to be operated on depending on their extension.
  *
  *
  *  The default value is nil i.e. all file extensions are allowed.
  *  The default value is nil i.e. all file extensions are allowed.
  */
  */
 @property(nonatomic, copy) NSArray* allowedFileExtensions;
 @property(nonatomic, copy) NSArray* allowedFileExtensions;
 
 
 /**
 /**
- *  Sets if files and directories whose name start with a period should be
- *  listed and allowed to be uploaded, downloaded, moved or deleted.
+ *  Sets if files and directories whose name start with a period are allowed to
+ *  be operated on.
  *
  *
  *  The default value is NO.
  *  The default value is NO.
  */
  */
 @property(nonatomic) BOOL allowHiddenItems;
 @property(nonatomic) BOOL allowHiddenItems;
 
 
 /**
 /**
- *  Sets the title for the uploader interface.
+ *  Sets the title for the uploader web interface.
  *
  *
  *  The default value is the application name.
  *  The default value is the application name.
  *
  *
@@ -110,7 +112,7 @@
 @property(nonatomic, copy) NSString* title;
 @property(nonatomic, copy) NSString* title;
 
 
 /**
 /**
- *  Sets the header for the uploader interface.
+ *  Sets the header for the uploader web interface.
  *
  *
  *  The default value is the same as the title property.
  *  The default value is the same as the title property.
  *
  *
@@ -120,7 +122,7 @@
 @property(nonatomic, copy) NSString* header;
 @property(nonatomic, copy) NSString* header;
 
 
 /**
 /**
- *  Sets the prologue for the uploader interface.
+ *  Sets the prologue for the uploader web interface.
  *
  *
  *  The default value is a short help text.
  *  The default value is a short help text.
  *
  *
@@ -130,7 +132,7 @@
 @property(nonatomic, copy) NSString* prologue;
 @property(nonatomic, copy) NSString* prologue;
 
 
 /**
 /**
- *  Sets the epilogue for the uploader interface.
+ *  Sets the epilogue for the uploader web interface.
  *
  *
  *  The default value is nil i.e. no epilogue.
  *  The default value is nil i.e. no epilogue.
  *
  *
@@ -140,7 +142,7 @@
 @property(nonatomic, copy) NSString* epilogue;
 @property(nonatomic, copy) NSString* epilogue;
 
 
 /**
 /**
- *  Sets the footer for the uploader interface.
+ *  Sets the footer for the uploader web interface.
  *
  *
  *  The default value is the application name and version.
  *  The default value is the application name and version.
  *
  *
@@ -164,7 +166,7 @@
 @interface GCDWebUploader (Subclassing)
 @interface GCDWebUploader (Subclassing)
 
 
 /**
 /**
- *  This method is called to check if a file is allowed to be uploaded.
+ *  This method is called to check if a file upload is allowed to complete.
  *  The uploaded file is available for inspection at "tempPath".
  *  The uploaded file is available for inspection at "tempPath".
  *
  *
  *  The default implementation returns YES.
  *  The default implementation returns YES.