|
30 | 30 | @class GCDWebUploader; |
31 | 31 |
|
32 | 32 | /** |
33 | | - * Delegate methods for GCDWebUploaderDelegate. |
| 33 | + * Delegate methods for GCDWebUploader. |
34 | 34 | * |
35 | 35 | * @warning These methods are always called on the main thread in a serialized way. |
36 | 36 | */ |
|
70 | 70 | * or directories. |
71 | 71 | * |
72 | 72 | * See the README.md file for more information about the features of GCDWebUploader. |
| 73 | + * |
| 74 | + * @warning For GCDWebUploader to work, "GCDWebUploader.bundle" must be added |
| 75 | + * to the resources of the Xcode target. |
73 | 76 | */ |
74 | 77 | @interface GCDWebUploader : GCDWebServer |
75 | 78 |
|
76 | 79 | /** |
77 | | - * Returns the upload directory as specified when the server was initialized. |
| 80 | + * Returns the upload directory as specified when the uploader was initialized. |
78 | 81 | */ |
79 | 82 | @property(nonatomic, readonly) NSString* uploadDirectory; |
80 | 83 |
|
81 | 84 | /** |
82 | | - * Sets the delegate for the server. |
| 85 | + * Sets the delegate for the uploader. |
83 | 86 | */ |
84 | 87 | @property(nonatomic, assign) id<GCDWebUploaderDelegate> delegate; |
85 | 88 |
|
86 | 89 | /** |
87 | | - * Restricts which files should be listed and allowed to be uploaded, downloaded, |
88 | | - * moved or deleted depending on their extensions. |
| 90 | + * Sets which files are allowed to be operated on depending on their extension. |
89 | 91 | * |
90 | 92 | * The default value is nil i.e. all file extensions are allowed. |
91 | 93 | */ |
92 | 94 | @property(nonatomic, copy) NSArray* allowedFileExtensions; |
93 | 95 |
|
94 | 96 | /** |
95 | | - * Sets if files and directories whose name start with a period should be |
96 | | - * listed and allowed to be uploaded, downloaded, moved or deleted. |
| 97 | + * Sets if files and directories whose name start with a period are allowed to |
| 98 | + * be operated on. |
97 | 99 | * |
98 | 100 | * The default value is NO. |
99 | 101 | */ |
100 | 102 | @property(nonatomic) BOOL allowHiddenItems; |
101 | 103 |
|
102 | 104 | /** |
103 | | - * Sets the title for the uploader interface. |
| 105 | + * Sets the title for the uploader web interface. |
104 | 106 | * |
105 | 107 | * The default value is the application name. |
106 | 108 | * |
|
110 | 112 | @property(nonatomic, copy) NSString* title; |
111 | 113 |
|
112 | 114 | /** |
113 | | - * Sets the header for the uploader interface. |
| 115 | + * Sets the header for the uploader web interface. |
114 | 116 | * |
115 | 117 | * The default value is the same as the title property. |
116 | 118 | * |
|
120 | 122 | @property(nonatomic, copy) NSString* header; |
121 | 123 |
|
122 | 124 | /** |
123 | | - * Sets the prologue for the uploader interface. |
| 125 | + * Sets the prologue for the uploader web interface. |
124 | 126 | * |
125 | 127 | * The default value is a short help text. |
126 | 128 | * |
|
130 | 132 | @property(nonatomic, copy) NSString* prologue; |
131 | 133 |
|
132 | 134 | /** |
133 | | - * Sets the epilogue for the uploader interface. |
| 135 | + * Sets the epilogue for the uploader web interface. |
134 | 136 | * |
135 | 137 | * The default value is nil i.e. no epilogue. |
136 | 138 | * |
|
140 | 142 | @property(nonatomic, copy) NSString* epilogue; |
141 | 143 |
|
142 | 144 | /** |
143 | | - * Sets the footer for the uploader interface. |
| 145 | + * Sets the footer for the uploader web interface. |
144 | 146 | * |
145 | 147 | * The default value is the application name and version. |
146 | 148 | * |
|
164 | 166 | @interface GCDWebUploader (Subclassing) |
165 | 167 |
|
166 | 168 | /** |
167 | | - * This method is called to check if a file is allowed to be uploaded. |
| 169 | + * This method is called to check if a file upload is allowed to complete. |
168 | 170 | * The uploaded file is available for inspection at "tempPath". |
169 | 171 | * |
170 | 172 | * The default implementation returns YES. |
|
0 commit comments