Ticket #13426: MPRegistry.h.diff

MPRegistry.h

@@ -33 +33 @@
  *      POSSIBILITY OF SUCH DAMAGE.
  */
 
+/*!
+ @header
+ MPRegistry provides a programatic interface to the registry of installed ports.
+ The MPRegistry class is a wrapper around the Tcl Registry API. For interacting 
+ with all available ports, see the @link MPIndex MPIndex @/link.
+ */
 #import <Cocoa/Cocoa.h>
 #import "MPInterpreter.h"
 #import "MPPort.h"
 #import "MPReceipt.h"
 
+/*!
+ @class MPRegistry
+ @abstract The registry of installed ports.
+  */
 @interface MPRegistry : NSObject {
 
         MPInterpreter *interpreter;
@@ -47 +57 @@
 + (MPRegistry *)sharedRegistry;
 
 /*
- * Call [self installed:@""]
+ @brief Calls [self installed:@""]
  */
 - (NSDictionary *)installed;
 /*
- * Call [self installed:name version:@""]
+ @brief Calls [self installed:name version:@""]
+ @param name Text to match the port name
  */
 - (NSDictionary *)installed:(NSString *)name;
-/*
- * Returns a NSDictionary of MPReciepts keyed by port name
+/*!
+ @brief Returns an NSDictionary of MPReciepts keyed by port name
+ @param name Text to match the port name
+ @param version Text to match the port version
  */
 - (NSDictionary *)installed:(NSString *)name withVersion:(NSString *)version;
-/*
- * Return an array of installed port names
+/*!
+ @brief Returns an array of installed port names
+ @param name Text to match the port name
+ @param version Text to march the port version
  */
 - (NSArray *)installedAsArray:(NSString *)name withVersion:(NSString *)version;
-/*
- * Return an array of the files in the (installed and active) port
+/*!
+ @brief Returns an array of the files in the (installed and active) port
  */
 - (NSArray *)filesForPort:(NSString *)name;