Add documentation

FossilOrigin-Name: e4c8de38e0a1c749ea0f05f594091f16d659a4d2e329672fb7208a4ff36a77cb
This commit is contained in:
Jonathan Schleifer 2024-08-11 17:45:27 +00:00
parent 7a728f9bd3
commit 50b4eaa1ed
12 changed files with 185 additions and 21 deletions

View file

@ -22,15 +22,45 @@
OF_ASSUME_NONNULL_BEGIN
/**
* @class PGException PGException.h ObjPgSQL/ObjPgSQL.h
*
* @brief A PostgreSQL exception.
*/
@interface PGException: OFException
{
PGConnection *_connection;
OFString *_error;
OFString *_errorMessage;
}
/**
* @brief The connection for which the exception occurred.
*/
@property (readonly, nonatomic) PGConnection *connection;
/**
* @brief An error message for the exception.
*/
@property (readonly, nonatomic) OFString *errorMessage;
+ (instancetype)exception OF_UNAVAILABLE;
/**
* @brief Creates a new PostgreSQL exception.
*
* @param connection The connection for which the exception occurred
* @return A new, autoreleased PostgreSQL exception
*/
+ (instancetype)exceptionWithConnection: (PGConnection *)connection;
- (instancetype)init OF_UNAVAILABLE;
/**
* @brief Initializes an already allocated PostgreSQL exception.
*
* @param connection The connection for which the exception occurred
* @return An initialized PostgreSQL exception
*/
- (instancetype)initWithConnection: (PGConnection *)connection
OF_DESIGNATED_INITIALIZER;
@end