Adium

Changeset 24137

Show
Ignore:
Timestamp:
07/01/2008 01:46:10 AM (6 months ago)
Author:
evands
Message:

Fixed a gaggle of Doxygen documentation problems

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/Frameworks/Adium Framework/Resources/en.lproj/EditStateSheet.nib/classes.nib

    r23275 r24137  
    1414                </dict> 
    1515                <dict> 
     16                        <key>ACTIONS</key> 
     17                        <dict> 
     18                                <key>sendContent</key> 
     19                                <string>id</string> 
     20                        </dict> 
     21                        <key>CLASS</key> 
     22                        <string>AISendingTextView</string> 
     23                        <key>LANGUAGE</key> 
     24                        <string>ObjC</string> 
     25                        <key>OUTLETS</key> 
     26                        <dict> 
     27                                <key>target</key> 
     28                                <string>id</string> 
     29                        </dict> 
     30                        <key>SUPERCLASS</key> 
     31                        <string>NSTextView</string> 
     32                </dict> 
     33                <dict> 
    1634                        <key>CLASS</key> 
    1735                        <string>RBSplitView</string> 
    …… 
    2543                        <key>SUPERCLASS</key> 
    2644                        <string>RBSplitSubview</string> 
    27                 </dict> 
    28                 <dict> 
    29                         <key>ACTIONS</key> 
    30                         <dict> 
    31                                 <key>sendContent</key> 
    32                                 <string>id</string> 
    33                         </dict> 
    34                         <key>CLASS</key> 
    35                         <string>AISendingTextView</string> 
    36                         <key>LANGUAGE</key> 
    37                         <string>ObjC</string> 
    38                         <key>OUTLETS</key> 
    39                         <dict> 
    40                                 <key>target</key> 
    41                                 <string>id</string> 
    42                         </dict> 
    43                         <key>SUPERCLASS</key> 
    44                         <string>NSTextView</string> 
    4545                </dict> 
    4646                <dict> 

  • trunk/Frameworks/Adium Framework/Resources/en.lproj/EditStateSheet.nib/info.nib

    r23275 r24137  
    44<dict> 
    55        <key>IBFramework Version</key> 
    6         <string>629</string> 
     6        <string>667</string> 
    77        <key>IBLastKnownRelativeProjectPath</key> 
    8         <string>../../../../../Adium.xcodeproj</string> 
     8        <string>../../../../Adium.xcodeproj</string> 
    99        <key>IBOldestOS</key> 
    1010        <integer>5</integer> 
    1111        <key>IBOpenObjects</key> 
    1212        <array> 
    13                 <integer>18</integer> 
     13                <integer>6</integer> 
    1414        </array> 
    1515        <key>IBSystem Version</key> 
    16         <string>9C7010</string> 
     16        <string>9D34</string> 
    1717        <key>targetFramework</key> 
    1818        <string>IBCocoaFramework</string> 

  • trunk/Frameworks/Adium Framework/Source/AIAbstractAccount.h

    r23618 r24137  
    4848//Auto-Refreshing Status String 
    4949- (NSAttributedString *)autoRefreshingOutgoingContentForStatusKey:(NSString *)key; 
    50 - (void)autoRefreshingOutgoingContentForStatusKey:(NSString *)key selector:(SEL)selector; 
    5150- (void)autoRefreshingOutgoingContentForStatusKey:(NSString *)key selector:(SEL)selector context:(id)originalContext; 
    5251- (NSAttributedString *)autoRefreshingOriginalAttributedStringForStatusKey:(NSString *)key; 

  • trunk/Frameworks/Adium Framework/Source/AIAbstractAccount.m

    r24057 r24137  
    498498    } else if ([key isEqualToString:KEY_ACCOUNT_DISPLAY_NAME]) { 
    499499                if ([self enabled]) { 
    500                         [self autoRefreshingOutgoingContentForStatusKey:key selector:@selector(gotFilteredDisplayName:)]; 
     500                        [self autoRefreshingOutgoingContentForStatusKey:key selector:@selector(gotFilteredDisplayName:) context:nil]; 
    501501                } 
    502502 
    …… 
    765765 
    766766/*! 
    767  * @brief threaded autoRefreshingOutgoingContentForStatusKey 
    768  * 
    769  * Same as autoRefreshingOutgoingContentForStatusKey: but does its filtering in the contentController filterThread, 
    770  * sending back the filtered attributedString to self on selector "selector" whenever it's complete. 
     767 * @brief Filter outgoing content, notifying via a selector when done 
     768 * 
     769 * Same as autoRefreshingOutgoingContentForStatusKey: but allows delayed filters to be run (which may take 
     770 * multiple run loops). The filtered attributedString is sent to self on selector "selector" whenever it's complete. 
     771 * 
    771772 * @param key Property to check for auto-refreshing content 
    772773 * @param selector Selector to call when status string is updated 
    773774 * @param context Context to use for filtering the status string (Optional) 
    774775 */ 
    775 - (void)autoRefreshingOutgoingContentForStatusKey:(NSString *)key selector:(SEL)selector 
    776 { 
    777         [self autoRefreshingOutgoingContentForStatusKey:key selector:selector context:nil]; 
    778 } 
    779776- (void)autoRefreshingOutgoingContentForStatusKey:(NSString *)key selector:(SEL)selector context:(id)originalContext 
    780777{ 
    …… 
    11681165 
    11691166/*! 
    1170  * @brief Autoreconnect after delay 
    1171  * 
    1172  * Attempts to auto-reconnect after a delay 
    1173  * @param delayNumber Delay in seconds 
     1167 * @brief Autoreconnect after a specified delay 
     1168 * 
     1169 * @param delay Delay in seconds 
    11741170 */ 
    11751171- (void)autoReconnectAfterDelay:(NSTimeInterval)delay 

  • trunk/Frameworks/Adium Framework/Source/AIAbstractListObjectMenu.m

    r22589 r24137  
    146146 * @brief Returns a menu image for the object 
    147147 * 
     148 * @param listObject The object for which an image will be created 
    148149 * @param useUserIcon If YES, the status icon and user icon will be used. If NO, the status icon and service icon will be used. 
    149150 */ 

  • trunk/Frameworks/Adium Framework/Source/AIAccount.h

    r24061 r24137  
    9898@end 
    9999 
    100 //Support for privacy settings 
     100/*! 
     101 * @protocol AIAccount_Privacy 
     102 * @brief Support for privacy settings 
     103 * 
     104 * An AIAccount subclass may implement this protocol to support privacy settings 
     105 */ 
    101106@protocol AIAccount_Privacy 
    102     //Add a list object to the privacy list (either AIPrivacyTypePermit or AIPrivacyTypeDeny). Return value indicates success. 
     107    /*! 
     108         * @brief Add a list object to a privacy list 
     109         * 
     110         * @param inObject The object 
     111         * @param type Either AIPrivacyTypePermit or AIPrivacyTypeDeny 
     112         * 
     113         * @result Boolean success 
     114         */ 
    103115    -(BOOL)addListObject:(AIListObject *)inObject toPrivacyList:(AIPrivacyType)type; 
    104     //Remove a list object from the privacy list (either AIPrivacyTypePermit or AIPrivacyTypeDeny). Return value indicates success 
    105     -(BOOL)removeListObject:(AIListObject *)inObject fromPrivacyList:(AIPrivacyType)type; 
    106         //Return an array of AIListContacts on the specified privacy list.  Returns an empty array if no contacts are on the list. 
     116 
     117        /*! 
     118         * @brief Remove a list object from a privacy list 
     119         * 
     120         * @param inObject The object 
     121         * @param type Either AIPrivacyTypePermit or AIPrivacyTypeDeny 
     122         * 
     123         * @result Boolean success 
     124         */ 
     125        -(BOOL)removeListObject:(AIListObject *)inObject fromPrivacyList:(AIPrivacyType)type; 
     126 
     127        /*! 
     128         * @brief Get the contacts on the specified privacy list 
     129         * 
     130         * @result An NSArray of AIListContacts, or an empty array if no contacts are on the requested list 
     131         */ 
    107132        -(NSArray *)listObjectsOnPrivacyList:(AIPrivacyType)type; 
    108     //Set the privacy options 
     133     
     134        /*! 
     135         * @brief Set the privacy options 
     136         * 
     137         * @param option An AIPrivacyOption value 
     138         */ 
    109139    -(void)setPrivacyOptions:(AIPrivacyOption)option; 
    110         //Get the privacy options 
     140 
     141        /*! 
     142         * @brief Get the privacy options 
     143         * 
     144         * @result An AIPrivacyOption value 
     145         */ 
    111146        -(AIPrivacyOption)privacyOptions; 
    112147@end 
    …… 
    117152/*! 
    118153 * @class AIAccount 
    119  * @abstract An account of ours (one we connect to and use to talk to handles) 
    120  * @discussion The base AIAccount class provides no practical functionality, 
    121  * so almost all of the AIAccounts you deal with will be subclasses.  You will 
    122  * almost never need to talk directly with an AIAccount.  For information on 
    123  * accounts, check out 'working with accounts' and 'creating service code'. 
     154 * @brief An account of ours (one we connect to and use to talk to handles) 
     155 *  
     156 * AIAccount is effectively an abstract superclass, as it can do nothing useful on its own. 
     157 * Subclasses of AIAccount, however, inherit much power. With great power comes great responsibility. 
    124158 */ 
    125159@interface AIAccount : AIListObject { 
    …… 
    185219- (BOOL)closeChat:(AIChat *)chat; 
    186220- (BOOL)inviteContact:(AIListObject *)contact toChat:(AIChat *)chat withMessage:(NSString *)inviteMessage; 
    187 - (BOOL)joinGroupChatNamed:(NSString *)name; 
    188221- (void)sendTypingObject:(AIContentTyping *)inTypingObject; 
    189222- (BOOL)sendMessageObject:(AIContentMessage *)inMessageObject; 
    …… 
    226259 * 
    227260 * @param inWindowController The window controller which closed; an account may have kept track of what windows were showing its authorization prompts 
    228  * @param inDict A dictionary of authorization information created by the account originally and possibly modified 
     261 * @param infoDict A dictionary of authorization information created by the account originally and possibly modified 
    229262 * @param authorizationResponse An AIAuthorizationResponse indicating if authorization was granted or denied or if there was no response 
    230263 */ 

  • trunk/Frameworks/Adium Framework/Source/AIAccount.m

    r24061 r24137  
    189189 * @brief The UID will be changed. The account has a chance to perform modifications 
    190190 * 
    191  * For example, MSN adds @hotmail.com to the proposedUID and returns the new value 
     191 * For example, MSN adds \@hotmail.com to the proposedUID and returns the new value 
    192192 * 
    193193 * @param proposedUID The proposed, pre-filtered UID (filtered means it has no characters invalid for this servce) 
    …… 
    254254 * @brief The dialog asking for confirmation for deleting the account did return. 
    255255 * 
    256  * @parameter dialog The dialog that has completed 
    257  * @parameter returnCode One of the regular NSAlert return codes 
     256 * @param dialog The dialog that has completed 
     257 * @param returnCode One of the regular NSAlert return codes 
    258258 * 
    259259 * This method should be overridden when alertForAccountDeletion: was overridden, and/or asynchronous behavior is required. 
    …… 
    593593 
    594594/*! 
    595  * @brief Join a group chat 
    596  * 
    597  * Join a group chat by name 
    598  * @param contact AIListObject to invite 
    599  * @param chat AIChat they are being invited to 
    600  * @param inviteMessage NSString invite message for the invited contact 
    601  * @return YES on success 
    602  */ 
    603 - (BOOL)joinGroupChatNamed:(NSString *)name 
    604 { 
    605         // XXX - Do we need this method?  All chats are supposed to be treated equally and assuming a 'name' seems protocol specific -ai 
    606         return NO; 
    607 } 
    608  
    609 /*! 
    610595 * @brief Send a typing object 
    611596 * 
    …… 
    657642 * @brief Contact list editable? 
    658643 * 
    659  * Returns YES if the contact list is currently editable 
    660  * @param object AIContentObject to send 
    661  * @return YES on success 
     644 * @return YES if the contact list is currently editable 
    662645 */ 
    663646- (BOOL)contactListEditable 
    …… 
    830813 * @brief Allow the user to verify (or unverify) the identity being used for encryption in a chat 
    831814 * 
    832  * It is an error to call this on a chat which is not current encrypted. 
    833  * 
    834  * @param The chat 
     815 * It is an error to call this on a chat which is not currently encrypted. 
     816 * 
     817 * @param inChat The chat 
    835818 */ 
    836819- (void)promptToVerifyEncryptionIdentityInChat:(AIChat *)inChat 

  • trunk/Frameworks/Adium Framework/Source/AIContactAlertsControllerProtocol.h

    r23164 r24137  
    259259 
    260260/*! 
    261  * @protocol AIEventHandler <NSObject> 
     261 * @protocol AIEventHandler 
    262262 * @brief Protocol for a class which posts and supplies information about an Event 
    263263 * 
    …… 
    314314 
    315315/*! 
    316  * @protocol AIActionHandler <NSObject> 
     316 * @protocol AIActionHandler 
    317317 * @brief Protocol for an Action which can be taken in response to an Event 
    318318 * 

  • trunk/Frameworks/Adium Framework/Source/AIEditStateWindowController.m

    r23289 r24137  
    6464 * @param inStatusType AIStatusType to use initially if inStatusState is nil 
    6565 * @param inAccount The account which to configure the custom state window; nil to configure globally 
    66  * @param showSaveCheckbox YES if the save checkbox should be shown; NO if it should not. If YES, the title on an incoming status will be cleared to make it auto-update. 
     66 * @param inShowSaveCheckbox YES if the save checkbox should be shown; NO if it should not. If YES, the title on an incoming status will be cleared to make it auto-update. 
    6767 * @param parentWindow Parent window for a sheet, nil for a stand alone editor 
    6868 * @param inTarget Target object to notify when editing is complete 

  • trunk/Frameworks/Adium Framework/Source/AIEmoticon.m

    r17743 r24137  
    110110 * Individual emoticons within an emoticon pack may be enabled or disabled. 
    111111 * 
    112  * @param The new enabled state 
     112 * @param inEnabled The new enabled state 
    113113 */ 
    114114- (void)setEnabled:(BOOL)inEnabled 
    …… 
    162162 * 
    163163 * @param textEquivalent The text equivalent for this attributed string  
     164 * @param attach If YES, an image cell is immediately attached. If NO, no attachment cell is made. 
     165 * 
    164166 * @result The attributed string with the emoticon 
    165167 */ 

  • trunk/Frameworks/Adium Framework/Source/AIListContact.m

    r23876 r24137  
    351351 * @param isIdle YES if the contact is idle 
    352352 * @param idleSinceDate The date this contact went idle. Only relevant if isIdle is YES 
    353  * @param noitfy The NotifyTiming 
     353 * @param notify The NotifyTiming 
    354354 */ 
    355355- (void)setIdle:(BOOL)isIdle sinceDate:(NSDate *)idleSinceDate notify:(NotifyTiming)notify 
    …… 
    398398 * 
    399399 * @param warningLevel The warning level, an integer between 0 and 100 
     400 * @param notify The NotifyTiming 
    400401 */ 
    401402- (void)setWarningLevel:(int)warningLevel notify:(NotifyTiming)notify 

  • trunk/Frameworks/Adium Framework/Source/AIListObject.m

    r24087 r24137  
    635635 * 
    636636 * @param statusMessage Status message. May be nil. 
    637  * @param noitfy How to notify of the change. See -[ESObjectWithProperties setValue:forProperty:notify:]. 
     637 * @param notify How to notify of the change. See -[ESObjectWithProperties setValue:forProperty:notify:]. 
    638638 */ 
    639639- (void)setStatusMessage:(NSAttributedString *)statusMessage notify:(NotifyTiming)notify 

  • trunk/Frameworks/Adium Framework/Source/AIService.m

    r23830 r24137  
    5353 * UID, since both those values may change. 
    5454 * @param inUID A unique identifier for the account being created. 
    55  * @param inAccountNumber A unique number for the account being created. 
     55 * @param inInternalObjectID A unique internalObjectID for the account being created. 
    5656 * @return An AIAccount object for this service. 
    5757 */ 

  • trunk/Frameworks/Adium Framework/Source/AIStatusControllerProtocol.h

    r23581 r24137  
    8282 * Each of these dictionaries has KEY_STATUS_NAME, KEY_STATUS_DESCRIPTION, and KEY_STATUS_TYPE. 
    8383 * 
    84  * @param statusName A name which will be passed back to accounts of this service.  Internal use only.  Use the AIStatusController.h #defines where appropriate. 
    85  * @param description A human-readable localized description which will be shown to the user.  Use the AIStatusController.h #defines where appropriate. 
     84 * @param statusName A name which will be passed back to accounts of this service.  Internal use only.  Use the AIStatusController.h \#defines where appropriate. 
     85 * @param description A human-readable localized description which will be shown to the user.  Use the AIStatusController.h \#defines where appropriate. 
    8686 * @param type An AIStatusType, the general type of this status. 
    8787 * @param service The AIService for which to register the status 
    …… 
    9595 * 
    9696 * @param service The service for which to return a specific list of types, or nil to return all available types 
    97  * @param target The target for the menu items, which will have an action of @selector(selectStatus:) 
     97 * @param target The target for the menu items, which will have an action of \@selector(selectStatus:) 
    9898 * 
    9999 * @result The menu of statuses, separated by available and away status types 

  • trunk/Frameworks/Adium Framework/Source/AIStatusGroup.m

    r18689 r24137  
    258258} 
    259259 
    260 /*! 
    261  * @pragma mark Add a status item to this group 
     260#prgama mark - 
     261 
     262/*! 
     263 * @brief Add a status item to this group 
    262264 * 
    263265 * @param inStatusItem The item to add 
    …… 
    306308 
    307309/*! 
    308 * @brief Move a state 
     310 * @brief Move a state 
    309311 * 
    310312 * Move a state that already exists in Adium's state array to another index 
    311  * @param state AIStatus to move 
     313 * 
     314 * @param statusState AIStatus to move 
    312315 * @param destIndex Destination index 
    313316 */ 
    …… 
    338341 * 
    339342 * Replace a state in Adium's state array with another state. 
    340  * @param oldState AIStatus state that is in Adium's state array 
    341  * @param newState AIStatus state with which to replace oldState 
     343 * 
     344 * @param oldStatusState AIStatus state that is in Adium's state array 
     345 * @param newStatusState AIStatus state with which to replace oldState 
    342346 */ 
    343347- (void)replaceExistingStatusState:(AIStatus *)oldStatusState withStatusState:(AIStatus *)newStatusState 

  • trunk/Frameworks/Adium Framework/Source/AIStatusItem.m

    r22089 r24137  
    157157 * 
    158158 * @param iconType The AIStatusIconType to use 
     159 * @param direction The direction 
     160 * 
    159161 * @result An <tt>NSImage</tt> 
    160162 */ 

  • trunk/Frameworks/Adium Framework/Source/AIStatus.m

    r23275 r24137  
    369369 * @brief Set if this state should force an account to be idle? 
    370370 * 
    371  * @param shouldForceInitialIdle YES if the account will be forced to be idle 
    372  */- (void)setShouldForceInitialIdleTime:(BOOL)shouldForceInitialIdleTime 
     371 * @param shouldForceInitialIdleTime YES if the account will be forced to be idle 
     372 */ 
     373- (void)setShouldForceInitialIdleTime:(BOOL)shouldForceInitialIdleTime 
    373374{ 
    374375        [statusDict setObject:[NSNumber numberWithBool:shouldForceInitialIdleTime] 

  • trunk/Frameworks/Adium Framework/Source/AIStatusMenu.m

    r23830 r24137  
    141141 
    142142/*! 
    143 * @brief Add state menu items 
    144  * 
    145  * Adds all the necessary state menu items to a plugin's state menu 
    146  * @param stateMenuPlugin The state menu plugin we're updating 
     143 * @brief Rebuild the menu 
    147144 */ 
    148145- (void)rebuildMenu 

  • trunk/Frameworks/Adium Framework/Source/AIUserIcons.h

    r23653 r24137  
    4343 
    4444/*! 
    45  * @brief The priority at which this source should be used. See the #defines in AIUserIcons.h for posible values. 
     45 * @brief The priority at which this source should be used. See the \#defines in AIUserIcons.h for posible values. 
    4646 */ 
    4747- (AIUserIconPriority)priority; 

  • trunk/Frameworks/Adium Framework/Source/ESObjectWithProperties.m

    r23556 r24137  
    337337 * @brief Subclasses should implement this method to respond to a change of properties after notifications have been posted. 
    338338 * 
    339  * @param keys The keys 
    340339 * @param silent YES indicates that this should not trigger 'noisy' notifications - it is appropriate for notifications as an account signs on and notes tons of contacts. 
    341340 */ 

  • trunk/Frameworks/Adium Framework/Source/ESTextAndButtonsWindowController.m

    r21993 r24137  
    4343 * @param inMessage The <tt>NSAttributedString</tt> which is the body of text for the window. 
    4444 * @param inImage The NSImage to display; if nil, the default application icon will be shown 
    45  * @param target The target to send the selector <tt>textAndButtonsWindowDidEnd:(NSWindow *)window returnCode:(AITextAndButtonsReturnCode)returnCode userInfo:(id)userInfo</tt> when the sheet ends. 
     45 * @param inTarget The target to send the selector <tt>textAndButtonsWindowDidEnd:(NSWindow *)window returnCode:(AITextAndButtonsReturnCode)returnCode userInfo:(id)userInfo</tt> when the sheet ends. 
     46 * @param inUserInfo User info which will be passed back to inTarget 
    4647 * 
    4748 * @see AITextAndButtonsReturnCode 
    …… 
    128129 * @param inAlternateButton Leftmost button.  Hidden if nil. 
    129130 * @param inOtherButton Middle button.  Hidden if nil. inAlternateButton must be non-nil for inOtherButton to be used. 
    130  * @param parentWindow Window on which to display as a sheet.  Displayed as a normal window if nil. 
    131131 * @param inMessageHeader A plain <tt>NSString</tt> which will be displayed as a bolded header for the message.  Hidden if nil. 
    132132 * @param inMessage The <tt>NSAttributedString</tt> which is the body of text for the window. 
    133133 * @param inImage The NSImage to display; if nil, the default application icon will be shown 
    134  * @param target The target to send the selector <tt>textAndButtonsWindowDidEnd:(NSWindow *)window returnCode:(AITextAndButtonsReturnCode)returnCode userInfo:(id)userInfo</tt> when the sheet ends. 
     134 * @param inTarget The target to send the selector <tt>textAndButtonsWindowDidEnd:(NSWindow *)window returnCode:(AITextAndButtonsReturnCode)returnCode userInfo:(id)userInfo</tt> when the sheet ends. 
     135 * @param inUserInfo User info which will be passed back to inTarget 
    135136 * 
    136137 * @see AITextAndButtonsReturnCode 

  • trunk/Frameworks/AIUtilities Framework/Source/AIColorAdditions.h

    r22775 r24137  
    8383 *      @par    This method does not adjust the saturation of the receiver. For a method that does, see <code>darkenAndAdjustSaturationBy:</code>. 
    8484 * 
    85  *      @param  The amount (greater than 0.0 and at most 1.0) to subtract from the receiver's brightness. 
     85 *      @param  amount The amount (greater than 0.0 and at most 1.0) to subtract from the receiver's brightness. 
    8686 *      @return A new, darker color, in the calibrated-RGB color space. 
    8787 */ 
    …… 
    9595 *      @par    You would use this method when you want to darken a color while preserving the “color” apparent to the user. The usual reason to do this is to create two ends of a gradient from a single input color. 
    9696 * 
    97  *      @param  The amount (greater than 0.0 and at most 1.0) to subtract from the receiver's brightness and add to the receiver's saturation. 
     97 *      @param  amount The amount (greater than 0.0 and at most 1.0) to subtract from the receiver's brightness and add to the receiver's saturation. 
    9898 *      @return A new, darker, more saturated color, in the calibrated-RGB color space. 
    9999 */ 
    …… 
    124124 *      @par    Hue is expressed as a fraction of a circle. Red is any multiple of 1 (a whole circle), and will be returned as 0. 
    125125 * 
    126  *      @param  r       The red component of the color to convert. 
    127  *      @param  g       The green component of the color to convert. 
    128  *      @param  b       The blue component of the color to convert. 
    129126 *      @param  hue     A pointer to a \c float. If you don't pass \c NULL, this function will assign the hue component here. 
    130127 *      @param  saturation      A pointer to a \c float. If you don't pass \c NULL, this function will assign the saturation component here. 
    131128 *      @param  luminance       A pointer to a \c float. If you don't pass \c NULL, this function will assign the luminance (brightness) component here. 
     129 *      @param  r       The red component of the color to convert. 
     130 *      @param  g       The green component of the color to convert. 
     131 *      @param  b       The blue component of the color to convert.  
    132132 */ 
    133133void getHueLuminanceSaturationFromRGB(float *hue, float *luminance, float *saturation, float r, float g, float b); 
    …… 
    138138 *      @par    Hue is expressed as a fraction of a circle. Red is any multiple of 1 (a whole circle), such as 0. 
    139139 * 
    140  *      @param  hue     The hue component of the color to convert. 
    141  *      @param  saturation      The saturation component of the color to convert. 
    142  *      @param  luminance       The luminance (brightness) component of the color to convert. 
    143140 *      @param  r       A pointer to a \c float. If you don't pass \c NULL, this function will assign the red component here. 
    144141 *      @param  g       A pointer to a \c float. If you don't pass \c NULL, this function will assign the green component here. 
    145142 *      @param  b       A pointer to a \c float. If you don't pass \c NULL, this function will assign the blue component here. 
     143 *      @param  hue     The hue component of the color to convert. 
     144 *      @param  saturation      The saturation component of the color to convert. 
     145 *      @param  luminance       The luminance (brightness) component of the color to convert.  
    146146 */ 
    147147void getRGBFromHueLuminanceSaturation(float *r, float *g, float *b, float hue, float luminance, float saturation); 

  • trunk/Frameworks/AIUtilities Framework/Source/AIFloater.h

    r12722 r24137  
    6060 * 
    6161 * @param inVisible YES if the image should be shown on screen; NO if it should not 
    62  * @param animated If YES and inVisibile is the opposite of the current visibility, the image will fade into/out of view by changing its opacity over time towards its maximum (to fade in) or towards 0 (to fade out). 
     62 * @param animate If YES and inVisibile is the opposite of the current visibility, the image will fade into/out of view by changing its opacity over time towards its maximum (to fade in) or towards 0 (to fade out). 
    6363 */ 
    6464- (void)setVisible:(BOOL)inVisible animate:(BOOL)animate; 

  • trunk/Frameworks/AIUtilities Framework/Source/AIKeychain.h

    r21075 r24137  
    469469 * 
    470470 *      @param server The server that the password can be used to log into. 
     471 *      @param protocol The protocol of the service via which authentication should occur. 
    471472 *      @param outError On return, a pointer to either \c nil (hopefully) or an \c NSError describing what went wrong. 
    472473 *      @return A dictionary containing two keys: @"Username" (account), @"Password". If no matching keychain item exists, \c nil is returned. 

  • trunk/Frameworks/AIUtilities Framework/Source/AIMutableOwnerArray.h

    r21274 r24137  
    117117 * 
    118118 * Retrieve the object within the \c AIMutableOwnerArray owned by the specified owner. 
     119 * @param inOwner The owner 
    119120 * @return  Returns the object owned by \a inOwner. 
    120121 */ 
    …… 
    132133 * 
    133134 * Retrieve the owner within the \c AIMutableOwnerArray which owns the specified object.  If multiple owners own a single object, returns the one with the highest priority. 
    134  * @param inObject An object 
     135 * @param anObject An object 
    135136 * @return  Returns the owner which owns \a inObject. 
    136137 */ 

  • trunk/Frameworks/AIUtilities Framework/Source/AIOutlineView.h

    r22859 r24137  
    8686 * 
    8787 * Informs the delegate of a request to forward a key down event to the find panel text field,displaying it if necessary. The key down event was recieved by outlineView, and it determined it should be added to the search string 
    88  * Return YES iff the find panel can handle theEvent. If NO is returned, outlineView will forward theEvent to super 
    8988 * @param outlineView The <tt>NSOutlineView</tt> that the user wants to filter 
     89 * @param theEvent The key down event 
     90 * 
     91 * @result YES if the find panel handled theEvent. If NO, outlineView will forward theEvent to super for handling 
    9092 */ 
    9193- (BOOL)outlineView:(NSOutlineView *)outlineView forwardKeyEventToFindPanel:(NSEvent *)theEvent; 

  • trunk/Frameworks/AIUtilities Framework/Source/AIOutlineView.m

    r23983 r24137  
    268268                [[self delegate] outlineView:self draggedImage:image endedAt:screenPoint operation:operation]; 
    269269        } 
     270         
     271        [super draggedImage:image endedAt:screenPoint operation:operation]; 
    270272} 
    271273 

  • trunk/Frameworks/AutoHyperlinks Framework/AutoHyperlinks.framework.xcodeproj/project.pbxproj

    r23922 r24137  
    9797                7EF1C0210DDC846B00CFC182 /* MainMenu.nib */ = {isa = PBXFileReference; lastKnownFileType = wrapper.nib; name = MainMenu.nib; path = LinkDriver/MainMenu.nib; sourceTree = "<group>"; }; 
    9898                7EF1C0410DDC8F3600CFC182 /* LinkDriver.pch */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = LinkDriver.pch; path = LinkDriver/LinkDriver.pch; sourceTree = "<group>"; }; 
    99                 8DC2EF5A0486A6940098B216 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xml; name = Info.plist; path = Resources/Info.plist; sourceTree = "<group>"; }; 
     99                8DC2EF5A0486A6940098B216 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; name = Info.plist; path = Resources/Info.plist; sourceTree = "<group>"; }; 
    100100                8DC2EF5B0486A6940098B216 /* AutoHyperlinks.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = AutoHyperlinks.framework; sourceTree = BUILT_PRODUCTS_DIR; }; 
    101101/* End PBXFileReference section */ 

  • trunk/Frameworks/AutoHyperlinks Framework/Source/AHHyperlinkScanner.h

    r23927 r24137  
    7676 * @param useStrictChecking Use strict rules or not 
    7777 * @param index a pointer to the index the string starts at, for easy incrementing. 
     78 * @param validStatus a pointer to an AH_URI_VERIFICATION_STATUS which will be set to the status of the URL on return. Pass NULL if this information is not needed. 
    7879 * @return Boolean 
    7980 */ 

  • trunk/Frameworks/AutoHyperlinks Framework/Source/AHHyperlinkScanner.m

    r24113 r24137  
    279279        // if we have a valid URL then save the scanned string, and make a SHMarkedHyperlink out of it. 
    280280        // this way, we can preserve things like the matched string (to be converted to a NSURL), 
    281         // parent string, it's validation status (valid, file, degenerate, etc), and it's range in the parent string 
     281        // parent string, its validation status (valid, file, degenerate, etc), and its range in the parent string 
    282282                AH_URI_VERIFICATION_STATUS validStatus; 
    283283        if((finalStringLen > 0) && [AHHyperlinkScanner isStringValidURL:scanString usingStrict:strictChecking fromIndex:&stringOffset withStatus:&validStatus]){ 

  • trunk/Plugins/Dual Window Interface/AIAccountSelectionView.m

    r23785 r24137  
    135135 * @brief Set the chat associated with this selection view 
    136136 * 
    137  * @param chat AIChat instance this view representents 
     137 * @param inChat AIChat instance this view representents 
    138138 */ 
    139139- (void)setChat:(AIChat *)inChat 

  • trunk/Plugins/Purple Service/adiumPurpleConnection.m

    r21897 r24137  
    5454 
    5555/** Called when an error causes a connection to be disconnected. 
    56  *  Called before #disconnected.  This op is intended to replace 
    57  *  #report_disconnect.  If both are implemented, this will be called 
     56 *  Called before 'disconnected'.  This op is intended to replace 
     57 *  'report_disconnect'.  If both are implemented, this will be called 
    5858 *  first; however, there's no real reason to implement both. 
     59 *  @param gc           The PurpleConnection 
    5960 *  @param reason  why the connection ended, if known, or 
    60  *                 #PURPLE_CONNECTION_ERROR_OTHER_ERROR, if not. 
     61 *                 'PURPLE_CONNECTION_ERROR_OTHER_ERROR', if not. 
    6162 *  @param text  a localized message describing the disconnection 
    6263 *               in more detail to the user. 
    63  *  @see #purple_connection_error_reason 
    64  *  @since 2.3.0 
    6564 */ 
    6665void adiumPurpleConnReportDisconnectReason(PurpleConnection *gc, 

  • trunk/Plugins/Purple Service/adiumPurpleEventloop.m

    r24124 r24137  
    3939 
    4040/*! 
    41  * @class Holder for various source/timer information 
     41 * @class SourceInfo 
     42 * @brief Holder for various sou