Commits

Tuukka Norri committed 9f52b4c

Trying to fix problems with documentation links

Comments (0)

Files changed (3)

Sources/BXDatabaseContext.m

  * like pgsql://username:password\@hostname/database_name/.
  *
  * Various methods of this class take an NSError parameter. If the parameter isn't set, the context
- * will handle errors by throwing a BXException named kBXFailedToExecuteQueryException. 
+ * will handle errors by throwing a BXException named \em kBXFailedToExecuteQueryException. 
  * See BXDatabaseContextDelegate::databaseContext:hadError:willBePassedOn:.
  *
  * \note This class is not thread-safe, i.e. 

Sources/BXDatabaseContextDelegateProtocol.h

  * for some reason, the context will be set to return \em nil for all non-cached object 
  * values.
  *
- * Foundation applications will throw a BXException named kBXExceptionUnhandledError.
+ * Foundation applications will throw a BXException named \em kBXExceptionUnhandledError.
  * 
  * \note -databaseContext:hadError:willBePassedOn: won't be called for this error.
  */

Sources/BaseTen.h

  *
  *
  * Connection to the database may be made synchronously using the method
- * BXDatabaseContext::connectSync:. Applications that use an NSRunLoop also have the
- * option to use BXDatabaseContext::connectAsync. The method returns immediately. When the connection 
+ * #connectSync:. Applications that use an NSRunLoop also have the
+ * option to use #connectAsync. The method returns immediately. When the connection 
  * attempt has finished, the context's delegate will be called and notifications will
  * be posted to the context's notification center (accessed with BXDatabaseContext::notificationCenter).
  *
  * In AppKit applications, the easiest way to connect to the database is to use the IBAction
- * BXDatabaseContext::connect:. In addition to attempting the connection asynchronously,
+ * #connect:. In addition to attempting the connection asynchronously,
  * it also presents a number of panels to the user, if some required information is missing from the URI. 
  * The panels allow the user to specify their username, password and the database host making URIs
  * like <tt>pgsql:///database_name</tt> allowed. Additionally a \em kBXConnectionSetupAlertDidEndNotification
  *
  * BXEntityDescriptions are used to specify tables for fetches. For getting a specific 
  * entity description, BXDatabaseContext has two methods: 
- * \ref BXDatabaseContext::entityForTable:error: "-entityForTable:error:" and 
- * \ref BXDatabaseContext::entityForTable:inSchema:error: "-entityForTable:inSchema:error:". 
+ * #entityForTable:error: and #entityForTable:inSchema:error:.
  * Entity descriptions may be accessed before making a
  * connection in which case the database context will check their existence on connect.
  *
  * NSPredicates are created by various Cocoa objects and may be passed directly to BXDatabaseContext.
- * One way to create ad-hoc predicates is by using NSPredicate::predicateWithFormat:.
+ * One way to create ad-hoc predicates is by using NSPredicate's method -predicateWithFormat:.
  * In this example, we fetch all the objects instead of filtering them, though.
  */
 
  * <code>NSArray* result = [ctx executeFetchForEntity: entity predicate: nil error: NULL];</code>
  * \endhtmlonly
  *
- * BXDatabaseContext's method 
- * \ref BXDatabaseContext::executeFetchForEntity:withPredicate:error: "-executeFetchForEntity:withPredicate:error:"
+ * BXDatabaseContext's method #executeFetchForEntity:withPredicate:error:
  * and its variations may be used to fetch objects from the database. The method takes a BXEntityDescription 
  * and an NSPredicate and performs a fetch synchronously. The fetched objects are returned in an NSArray.
  */