From 144f2a34f982b5e54907225977b6770646e94f4d Mon Sep 17 00:00:00 2001 From: Alexander Strange Date: Wed, 5 Feb 2003 06:21:37 +0000 Subject: [PATCH] Partial addition of HeaderDoc --- ITMTRemote.h | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/ITMTRemote.h b/ITMTRemote.h index b2e2d5e..3527c85 100755 --- a/ITMTRemote.h +++ b/ITMTRemote.h @@ -22,18 +22,29 @@ * */ +/*! @header ITMTRemote + * @abstract Declares the necessary protocol and class to implement a MenuTunes Remote. + */ + #import -@protocol ITMTRemote +/*! @protocol ITMTRemote + * @abstract Declares what a MenuTunes Remote must be able to do. + * @discussion A MenuTunes Remote must be able to return and change state information. + */ +@protocol ITMTRemote +/*! @method remote: + * @abstract Return an autoreleased instance of the remote. + * @discussion Should be very quick and compact. + * EXAMPLE: + * + (id)remote + * { + * return [[[MyRemote alloc] init] autorelease]; + * } + * @result The instance. + */ + (id)remote; -// Return an autoreleased instance of the remote. -// Should be very quick and compact. -// EXAMPLE: -// + (id)remote -// { -// return [[[MyRemote alloc] init] autorelease]; -// } - (NSString *)title; // Return the title of the remote. -- 2.20.1