Tuukka Norri avatar Tuukka Norri committed 4327a5f

Added \brief tags to BaseTenAppKit, too

Comments (0)

Files changed (6)

BaseTenAppKit/Sources/BXNetServiceConnector.m

 
 
 /**
- * A connection setup manager for use with Bonjour.
+ * \brief A connection setup manager for use with Bonjour.
+ *
  * Determines connection information from the database URI
  * and then presents dialogs for the missing information.
  * \note Presently one is created automatically in BXDatabaseContext::connect:.

BaseTenAppKit/Sources/BXObjectStatusToColorTransformer.m

 
 
 /**
- * Transforms an object status to a colour.
+ * \brief Transforms an object status to a colour.
+ *
  * Presently, grey corresponds to a locked object and red to a deleted object.
  * \ingroup value_transformers
  */

BaseTenAppKit/Sources/BXObjectStatusToEditableTransformer.m

 #import <BaseTen/BXDatabaseObject.h>
 
 /**
- * Transforms and object's status into a boolean indicating, whether it's editable or not.
+ * \brief Transforms and object's status into a boolean indicating, whether it's editable or not.
+ *
  * If object has been edited or deleted in another transaction, it won't be editable.
  * \ingroup value_transformers
  */

BaseTenAppKit/Sources/BXSynchronizedArrayController.h

 
 @interface BXSynchronizedArrayController : NSArrayController
 {
-	/** The database context. */
+	/** \brief The database context. */
 	IBOutlet BXDatabaseContext* databaseContext;
-	/** An NSWindow to which sheets are attached. */
+	/** \brief An NSWindow to which sheets are attached. */
     IBOutlet NSWindow* modalWindow;
         
     BXEntityDescription* mEntityDescription; //Weak

BaseTenAppKit/Sources/BXSynchronizedArrayController.m

 
 
 /**
- * An NSArrayController subclass for use with BaseTen.
+ * \brief An NSArrayController subclass for use with BaseTen.
+ *
  * A BXSynchronizedArrayController updates its contents automatically based on notifications received 
  * from a database context. In order to function, its databaseContext outlet needs to be connected. 
  * It may also fetch objects when the context connects. However, this option should not be enabled 
 }
 
 /**
- * The entity used with this array controller.
+ * \brief The entity used with this array controller.
  */
 - (BXEntityDescription *) entityDescription
 {
 }
 
 /**
- * Set the entity used with this array controller.
+ * \brief Set the entity used with this array controller.
  */
 - (void) setEntityDescription: (BXEntityDescription *) desc
 {
 }
 
 /**
- * Set the database context.
  * \internal
+ * \brief Set the database context.
  * \see #setFetchesOnAwake:
  */
 - (void) setDatabaseContext: (BXDatabaseContext *) ctx
 }
 
 /**
- * Whether this controller fetches on connect.
+ * \internal
+ * \brief Whether this controller fetches on connect.
  * \note Controllers bound to an automatically-fetching controller should not fetch on connect.
- * \internal
  * \see #setDatabaseContext:
  */
 - (void) setFetchesOnConnect: (BOOL) aBool
 }
 
 /**
- * Database schema name for this controller.
+ * \brief Database schema name for this controller.
  */
 - (NSString *) schemaName
 {
 }
 
 /**
- * Set the database schema name for this controller.
+ * \brief Set the database schema name for this controller.
  */
 - (void) setSchemaName: (NSString *) aSchemaName
 {
 }
 
 /**
- * Database table name for this controller.
+ * \brief Database table name for this controller.
  */
 - (NSString *) tableName
 {
 }
 
 /**
- * Set the database table name for this controller.
+ * \brief Set the database table name for this controller.
  */
 - (void) setTableName: (NSString *) aTableName
 {
 }
 
 /**
- * Database object class name for this controller.
+ * \brief Database object class name for this controller.
+ *
  * When setting the database context, this will be changed into a Class.
  */
 - (NSString *) databaseObjectClassName
 }
 
 /**
- * Set the database object class name for this controller.
+ * \brief Set the database object class name for this controller.
  */
 - (void) setDatabaseObjectClassName: (NSString *) aDBObjectClassName
 {

BaseTenAppKit/Sources/NSController+BXAppKitAdditions.m

 @implementation NSObjectController (BXCocoaAdditions)
 /** 
  * \internal
- * A convenience method for locking the key in the currently selected object. 
+ * \brief A convenience method for locking the key in the currently selected object. 
  */
 - (void) BXLockKey: (NSString *) key status: (enum BXObjectLockStatus) status editor: (id) editor
 {
 
 
 /**
- * Some methods used by BaseTen in BXArrayController.
+ * \brief Some methods used by BaseTen in BXArrayController.
  * \ingroup baseten_appkit
  */
 @implementation NSController (BXCocoaAdditions)
 
 /** 
  * \internal
- * Lock an object asynchronously. 
+ * \brief Lock an object asynchronously. 
  */
 - (void) BXLockObject: (BXDatabaseObject *) object key: (NSString *) key 
                   status: (enum BXObjectLockStatus) status editor: (id) editor
 
 /** 
  * \internal
- * Unlock an object synchronously. 
+ * \brief Unlock an object synchronously. 
  */
 - (void) BXUnlockObject: (BXDatabaseObject *) object key: (NSString *) key editor: (id) editor
 {
 
 /** 
  * \internal 
- * Handle the error if a lock couldn't be acquired. 
+ * \brief Handle the error if a lock couldn't be acquired. 
  */
 - (void) BXLockAcquired: (BOOL) lockAcquired object: (BXDatabaseObject *) receiver error: (NSError *) dbError
 {
 }
 
 /** 
- * The database context. 
+ * \internal
+ * \brief The database context. 
  */
 - (BXDatabaseContext *) BXDatabaseContext
 {
 }
 
 /** 
- * The window in which all the edited NSControls are. 
+ * \internal
+ * \brief The window in which all the edited NSControls are. 
  */
 - (NSWindow *) BXWindow
 {
 }
 
 /**
- * An error handler.
+ * \internal
+ * \brief An error handler.
  */
 - (void) BXHandleError: (NSError *) error
 {
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.