gnustep/libs-ec
0
0
Fork 0
mirror of https://github.com/gnustep/libs-ec.git synced 2025-06-01 09:42:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

documentation tweak

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/ec/trunk@36503 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald 2013-04-11 11:18:53 +00:00
parent a1277b84c3
commit ab2a9854d9
1 changed files with 10 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

16
EcAlerter.h
View file

@ -304,7 +304,7 @@
* <desc>An integer number of minutes between generating alerts * <desc>An integer number of minutes between generating alerts
* reminding about alarms. If this is negative or not * reminding about alarms. If this is negative or not
* set then it defaults to zero ... meaning that no reminders * set then it defaults to zero ... meaning that no reminders
* are sent. * are sent.</desc>
* </deflist> * </deflist>
*/ */
@interface EcAlerter : NSObject @interface EcAlerter : NSObject
@ -385,13 +385,15 @@
* <p>Each message must be a line of the format -<br /> * <p>Each message must be a line of the format -<br />
* serverName(hostName): YYYY-MM-DD hh:mm:ss.mmm szzzz type - text * serverName(hostName): YYYY-MM-DD hh:mm:ss.mmm szzzz type - text
* </p> * </p>
* <p>Each message is parsed an then the components are passed to * <p>Each message is parsed an then the components are passed to the
* the -handleEvent:withHost:andServer:timestamp:identifier:severity: method. * -handleEvent:withHost:andServer:timestamp:identifier:severity:reminder:
* method.
* </p> * </p>
*/ */
- (void) handleInfo: (NSString*)str; - (void) handleInfo: (NSString*)str;
/** Called by -handleEvent:withHost:andServer:timestamp:identifier:severity: /** Called by
* -handleEvent:withHost:andServer:timestamp:identifier:severity:reminder
* to log a message to an array of destinations. * to log a message to an array of destinations.
*/ */
- (void) log: (NSMutableDictionary*)m - (void) log: (NSMutableDictionary*)m
@ -403,7 +405,8 @@
*/ */
- (void) log: (NSMutableDictionary*)m to: (NSArray*)destinations; - (void) log: (NSMutableDictionary*)m to: (NSArray*)destinations;
/** Called by -handleEvent:withHost:andServer:timestamp:identifier:severity: /** Called by
* -handleEvent:withHost:andServer:timestamp:identifier:severity:reminder:
* to pass a message to an array of destinations. * to pass a message to an array of destinations.
* The message is actually appended to any cached messages for those * The message is actually appended to any cached messages for those
* destinations ... and the cache is periodically flushed. * destinations ... and the cache is periodically flushed.
@ -423,7 +426,8 @@
*/ */
- (BOOL) setRules: (NSArray*)ra; - (BOOL) setRules: (NSArray*)ra;
/** Called by -handleEvent:withHost:andServer:timestamp:identifier:severity: /** Called by
* -handleEvent:withHost:andServer:timestamp:identifier:severity:reminder:
* to pass a message to an array of destinations. * to pass a message to an array of destinations.
* The message replaces any cached messages for those * The message replaces any cached messages for those
* destinations (and has a count of the lost messages noted) ... and * destinations (and has a count of the lost messages noted) ... and