Tuukka Norri avatar Tuukka Norri committed 020b423

Documentation
- Documented some enums. However, Doxygen doesn't generate documentation for them.

Comments (0)

Files changed (4)

Sources/BXConstants.h

     kBXRelationshipManyToMany    = (1 << 2)
 };
 
+/** \brief SSL certificate policy. */
 enum BXCertificatePolicy
 {
-	kBXCertificatePolicyUndefined			= 0,
-	kBXCertificatePolicyAllow,
-	kBXCertificatePolicyDeny,
-	kBXCertificatePolicyDisplayTrustPanel
+	kBXCertificatePolicyUndefined = 0, /**< Certificate policy is unspecified. */
+	kBXCertificatePolicyAllow, /** Untrusted certificates are allowed. */
+	kBXCertificatePolicyDeny, /** Untrusted certificates are denied. */
+	kBXCertificatePolicyDisplayTrustPanel /** A trust panel will be displayed to the user. */
 };
 
+/** \brief SSL connection mode. */
 enum BXSSLMode
 {
-	kBXSSLModeUndefined	= 0,
-	kBXSSLModeRequire,
-	kBXSSLModeDisable,
-	kBXSSLModePrefer
+	kBXSSLModeUndefined	= 0, /**< SSL mode is unspecified. */
+	kBXSSLModeRequire, /** SSL is required. */
+	kBXSSLModeDisable, /** SSL has been disabled. */
+	kBXSSLModePrefer /** A secure connection will be attempted at first. */
 };
 
 enum BXConnectionErrorHandlingState

Sources/BXDatabaseContext.h

 	id <BXDatabaseContextDelegate>			mDelegateProxy;
 	NSError*								mLastConnectionError;
 	
-	/** \brief An NSWindow to which sheets are attached. \see -modalWindow */
-	IBOutlet NSWindow*						modalWindow;
-	/** \brief The context's delegate. \see -delegate */
-	IBOutlet id	<BXDatabaseContextDelegate>	delegate;
+	IBOutlet NSWindow*						modalWindow; /**< \brief An NSWindow to which sheets are attached. \see -modalWindow */
+	IBOutlet id	<BXDatabaseContextDelegate>	delegate; 	/**< \brief The context's delegate. \see -delegate */
 	
 	enum BXConnectionErrorHandlingState		mConnectionErrorHandlingState;
 

Sources/BXDatabaseContext.m

  *
  * Entities in private and metadata schemata won't be included.
  * \param reload Whether the entity list should be reloaded.
- * \param       error           If an error occurs, this pointer is set to an NSError instance.
- *                              May be NULL.
+ * \param outError If an error occurs, this pointer is set to an NSError instance. May be NULL.
  * \return An NSDicionary with NSStrings corresponding to schema names as keys and NSDictionarys as objects. 
  *         Each of them will have NSStrings corresponding to relation names as keys and BXEntityDescriptions
  *         as objects.

Sources/BXPropertyDescription.h

 #endif 
 	
 
+/** \brief Property kind. */
 enum BXPropertyKind
 {
-	kBXPropertyNoKind = 0,
-	kBXPropertyKindAttribute,
-	kBXPropertyKindRelationship
+	kBXPropertyNoKind = 0, /**< Kind is unspecified. */
+	kBXPropertyKindAttribute, /**< The property is an attribute. */
+	kBXPropertyKindRelationship /**< The property is a relationship. */
 };
 
 
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.