Ticket #13426: MPRegistry.h.diff

File MPRegistry.h.diff, 1.8 KB (added by kirk.kelsey@…, 17 years ago)

MPRegistry.h diff (against subversion revision 31513)

  • MPRegistry.h

     
    3333 *      POSSIBILITY OF SUCH DAMAGE.
    3434 */
    3535
     36/*!
     37 @header
     38 MPRegistry provides a programatic interface to the registry of installed ports.
     39 The MPRegistry class is a wrapper around the Tcl Registry API. For interacting
     40 with all available ports, see the @link MPIndex MPIndex @/link.
     41 */
    3642#import <Cocoa/Cocoa.h>
    3743#import "MPInterpreter.h"
    3844#import "MPPort.h"
    3945#import "MPReceipt.h"
    4046
     47/*!
     48 @class MPRegistry
     49 @abstract The registry of installed ports.
     50  */
    4151@interface MPRegistry : NSObject {
    4252
    4353        MPInterpreter *interpreter;
     
    4757+ (MPRegistry *)sharedRegistry;
    4858
    4959/*
    50  * Call [self installed:@""]
     60 @brief Calls [self installed:@""]
    5161 */
    5262- (NSDictionary *)installed;
    5363/*
    54  * Call [self installed:name version:@""]
     64 @brief Calls [self installed:name version:@""]
     65 @param name Text to match the port name
    5566 */
    5667- (NSDictionary *)installed:(NSString *)name;
    57 /*
    58  * Returns a NSDictionary of MPReciepts keyed by port name
     68/*!
     69 @brief Returns an NSDictionary of MPReciepts keyed by port name
     70 @param name Text to match the port name
     71 @param version Text to match the port version
    5972 */
    6073- (NSDictionary *)installed:(NSString *)name withVersion:(NSString *)version;
    61 /*
    62  * Return an array of installed port names
     74/*!
     75 @brief Returns an array of installed port names
     76 @param name Text to match the port name
     77 @param version Text to march the port version
    6378 */
    6479- (NSArray *)installedAsArray:(NSString *)name withVersion:(NSString *)version;
    65 /*
    66  * Return an array of the files in the (installed and active) port
     80/*!
     81 @brief Returns an array of the files in the (installed and active) port
    6782 */
    6883- (NSArray *)filesForPort:(NSString *)name;
    6984