git.ithinksw.org
/
MenuTunes.git
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
144f2a3
)
Replacement of all comments with HeaderDoc
author
Alexander Strange
<astrange@ithinksw.com>
Wed, 5 Feb 2003 06:33:14 +0000
(06:33 +0000)
committer
Alexander Strange
<astrange@ithinksw.com>
Wed, 5 Feb 2003 06:33:14 +0000
(06:33 +0000)
ITMTRemote.h
patch
|
blob
|
history
diff --git
a/ITMTRemote.h
b/ITMTRemote.h
index
3527c85
..
3e8c9bd
100755
(executable)
--- a/
ITMTRemote.h
+++ b/
ITMTRemote.h
@@
-34,32
+34,47
@@
*/
@protocol ITMTRemote
*/
@protocol ITMTRemote
-/*! @method remote
:
- * @abstract Return an autoreleased instance of the remote.
+/*! @method remote
+ * @abstract Return
s
an autoreleased instance of the remote.
* @discussion Should be very quick and compact.
* @discussion Should be very quick and compact.
- * EXAMPLE:
- * + (id)remote
- * {
- * return [[[MyRemote alloc] init] autorelease];
- * }
- * @result The instance.
+ *
EXAMPLE:
+ *
+ (id)remote
+ *
{
+ *
return [[[MyRemote alloc] init] autorelease];
+ *
}
+ *
@result The instance.
*/
+ (id)remote;
*/
+ (id)remote;
+/*! @method title:
+ * @abstract Returns an autoreleased instance of the remote.
+ * @result An NSString containing the title.
+ */
- (NSString *)title;
- (NSString *)title;
-// Return the title of the remote.
+/*! @method description:
+ * @abstract Returns a description of the remote.
+ * @result An NSString containing the description.
+ */
- (NSString *)description;
- (NSString *)description;
-// Return a short description of the remote.
+/*! @method icon:
+ * @abstract Returns a icon for the remote.
+ * @result An NSImage containing the icon.
+ */
- (NSImage *)icon;
- (NSImage *)icon;
-// Return a 16x16 icon representation for the remote.
+/*! @method begin:
+ * @abstract Sent when the plugin should begin operation.
+ * @result A result code signifying success.
+ */
- (BOOL)begin;
- (BOOL)begin;
-// Sent to the plugin when it should begin operation.
+/*! @method halt:
+ * @abstract Sent when the plugin should cease operation.
+ * @result A result code signifying success.
+ */
- (BOOL)halt;
- (BOOL)halt;
-// Sent to the plugin when it should cease operation.
- (NSArray *)sources;
- (int)currentSourceIndex;
- (NSArray *)sources;
- (int)currentSourceIndex;