Skip to content

Commit 65605ce

Browse files
committed
Remove redundant comments for APM event methods
1 parent 3ea1a47 commit 65605ce

File tree

3 files changed

+0
-51
lines changed

3 files changed

+0
-51
lines changed

src/MongoDB/Monitoring/CommandFailedEvent.c

Lines changed: 0 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ zend_class_entry* php_phongo_commandfailedevent_ce;
3131

3232
PHONGO_DISABLED_CONSTRUCTOR(MongoDB_Driver_Monitoring_CommandFailedEvent)
3333

34-
/* Returns the command name for this event */
3534
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getCommandName)
3635
{
3736
php_phongo_commandfailedevent_t* intern;
@@ -43,7 +42,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getCommandName)
4342
RETVAL_STRING(intern->command_name);
4443
}
4544

46-
/* Returns the database name for this event */
4745
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getDatabaseName)
4846
{
4947
php_phongo_commandfailedevent_t* intern;
@@ -55,7 +53,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getDatabaseName)
5553
RETVAL_STRING(intern->database_name);
5654
}
5755

58-
/* Returns the event's duration in microseconds */
5956
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getDurationMicros)
6057
{
6158
php_phongo_commandfailedevent_t* intern;
@@ -67,7 +64,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getDurationMicro
6764
RETURN_LONG(intern->duration_micros);
6865
}
6966

70-
/* Returns the error document associated with the event */
7167
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getError)
7268
{
7369
php_phongo_commandfailedevent_t* intern;
@@ -79,7 +75,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getError)
7975
RETURN_ZVAL(&intern->z_error, 1, 0);
8076
}
8177

82-
/* Returns this event's host */
8378
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getHost)
8479
{
8580
php_phongo_commandfailedevent_t* intern = Z_COMMANDFAILEDEVENT_OBJ_P(getThis());
@@ -89,7 +84,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getHost)
8984
RETVAL_STRING(intern->host.host);
9085
}
9186

92-
/* Returns the event's operation ID */
9387
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getOperationId)
9488
{
9589
php_phongo_commandfailedevent_t* intern;
@@ -103,7 +97,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getOperationId)
10397
RETVAL_STRING(operation_id);
10498
}
10599

106-
/* Returns this event's port */
107100
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getPort)
108101
{
109102
php_phongo_commandfailedevent_t* intern = Z_COMMANDFAILEDEVENT_OBJ_P(getThis());
@@ -113,7 +106,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getPort)
113106
RETVAL_LONG(intern->host.port);
114107
}
115108

116-
/* Returns the reply document associated with the event */
117109
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getReply)
118110
{
119111
php_phongo_commandfailedevent_t* intern;
@@ -133,7 +125,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getReply)
133125
RETURN_ZVAL(&state.zchild, 0, 1);
134126
}
135127

136-
/* Returns the event's request ID */
137128
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getRequestId)
138129
{
139130
php_phongo_commandfailedevent_t* intern;
@@ -147,7 +138,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getRequestId)
147138
RETVAL_STRING(request_id);
148139
}
149140

150-
/* Returns the Server from which the event originated */
151141
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getServer)
152142
{
153143
php_phongo_commandfailedevent_t* intern;
@@ -159,7 +149,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getServer)
159149
phongo_server_init(return_value, &intern->manager, intern->server_id);
160150
}
161151

162-
/* Returns the event's service ID */
163152
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getServiceId)
164153
{
165154
php_phongo_commandfailedevent_t* intern = Z_COMMANDFAILEDEVENT_OBJ_P(getThis());
@@ -173,7 +162,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getServiceId)
173162
phongo_objectid_new(return_value, &intern->service_id);
174163
}
175164

176-
/* Returns the event's server connection ID */
177165
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getServerConnectionId)
178166
{
179167
php_phongo_commandfailedevent_t* intern = Z_COMMANDFAILEDEVENT_OBJ_P(getThis());
@@ -194,12 +182,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandFailedEvent, getServerConnect
194182
RETURN_LONG(intern->server_connection_id);
195183
}
196184

197-
/**
198-
* Event thrown when a command has failed to execute.
199-
*
200-
* This class is only constructed internally.
201-
*/
202-
203185
/* MongoDB\Driver\Monitoring\CommandFailedEvent object handlers */
204186
static zend_object_handlers php_phongo_handler_commandfailedevent;
205187

src/MongoDB/Monitoring/CommandStartedEvent.c

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ zend_class_entry* php_phongo_commandstartedevent_ce;
3131

3232
PHONGO_DISABLED_CONSTRUCTOR(MongoDB_Driver_Monitoring_CommandStartedEvent)
3333

34-
/* Returns the command document associated with the event */
3534
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getCommand)
3635
{
3736
php_phongo_commandstartedevent_t* intern;
@@ -51,7 +50,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getCommand)
5150
RETURN_ZVAL(&state.zchild, 0, 1);
5251
}
5352

54-
/* Returns the command name for this event */
5553
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getCommandName)
5654
{
5755
php_phongo_commandstartedevent_t* intern;
@@ -63,7 +61,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getCommandName)
6361
RETVAL_STRING(intern->command_name);
6462
}
6563

66-
/* Returns the database name for this event */
6764
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getDatabaseName)
6865
{
6966
php_phongo_commandstartedevent_t* intern;
@@ -75,7 +72,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getDatabaseName
7572
RETVAL_STRING(intern->database_name);
7673
}
7774

78-
/* Returns this event's host */
7975
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getHost)
8076
{
8177
php_phongo_commandstartedevent_t* intern = Z_COMMANDSTARTEDEVENT_OBJ_P(getThis());
@@ -85,7 +81,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getHost)
8581
RETVAL_STRING(intern->host.host);
8682
}
8783

88-
/* Returns the event's operation ID */
8984
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getOperationId)
9085
{
9186
php_phongo_commandstartedevent_t* intern;
@@ -99,7 +94,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getOperationId)
9994
RETVAL_STRING(operation_id);
10095
}
10196

102-
/* Returns this event's port */
10397
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getPort)
10498
{
10599
php_phongo_commandstartedevent_t* intern = Z_COMMANDSTARTEDEVENT_OBJ_P(getThis());
@@ -109,7 +103,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getPort)
109103
RETVAL_LONG(intern->host.port);
110104
}
111105

112-
/* Returns the event's request ID */
113106
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getRequestId)
114107
{
115108
php_phongo_commandstartedevent_t* intern;
@@ -123,7 +116,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getRequestId)
123116
RETVAL_STRING(request_id);
124117
}
125118

126-
/* Returns the Server from which the event originated */
127119
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getServer)
128120
{
129121
php_phongo_commandstartedevent_t* intern;
@@ -135,7 +127,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getServer)
135127
phongo_server_init(return_value, &intern->manager, intern->server_id);
136128
}
137129

138-
/* Returns the event's service ID */
139130
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getServiceId)
140131
{
141132
php_phongo_commandstartedevent_t* intern = Z_COMMANDSTARTEDEVENT_OBJ_P(getThis());
@@ -149,7 +140,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getServiceId)
149140
phongo_objectid_new(return_value, &intern->service_id);
150141
}
151142

152-
/* Returns the event's server connection ID */
153143
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getServerConnectionId)
154144
{
155145
php_phongo_commandstartedevent_t* intern = Z_COMMANDSTARTEDEVENT_OBJ_P(getThis());
@@ -170,12 +160,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandStartedEvent, getServerConnec
170160
RETURN_LONG(intern->server_connection_id);
171161
}
172162

173-
/**
174-
* Event thrown when a command has started to execute.
175-
*
176-
* This class is only constructed internally.
177-
*/
178-
179163
/* MongoDB\Driver\Monitoring\CommandStartedEvent object handlers */
180164
static zend_object_handlers php_phongo_handler_commandstartedevent;
181165

src/MongoDB/Monitoring/CommandSucceededEvent.c

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ zend_class_entry* php_phongo_commandsucceededevent_ce;
3131

3232
PHONGO_DISABLED_CONSTRUCTOR(MongoDB_Driver_Monitoring_CommandSucceededEvent)
3333

34-
/* Returns the command name for this event */
3534
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getCommandName)
3635
{
3736
php_phongo_commandsucceededevent_t* intern;
@@ -43,7 +42,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getCommandNam
4342
RETVAL_STRING(intern->command_name);
4443
}
4544

46-
/* Returns the database name for this event */
4745
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getDatabaseName)
4846
{
4947
php_phongo_commandsucceededevent_t* intern;
@@ -55,7 +53,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getDatabaseNa
5553
RETVAL_STRING(intern->database_name);
5654
}
5755

58-
/* Returns the event's duration in microseconds */
5956
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getDurationMicros)
6057
{
6158
php_phongo_commandsucceededevent_t* intern;
@@ -67,7 +64,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getDurationMi
6764
RETURN_LONG(intern->duration_micros);
6865
}
6966

70-
/* Returns this event's host */
7167
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getHost)
7268
{
7369
php_phongo_commandsucceededevent_t* intern = Z_COMMANDSUCCEEDEDEVENT_OBJ_P(getThis());
@@ -77,7 +73,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getHost)
7773
RETVAL_STRING(intern->host.host);
7874
}
7975

80-
/* Returns the event's operation ID */
8176
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getOperationId)
8277
{
8378
php_phongo_commandsucceededevent_t* intern;
@@ -91,7 +86,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getOperationI
9186
RETVAL_STRING(operation_id);
9287
}
9388

94-
/* Returns this event's port */
9589
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getPort)
9690
{
9791
php_phongo_commandsucceededevent_t* intern = Z_COMMANDSUCCEEDEDEVENT_OBJ_P(getThis());
@@ -101,7 +95,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getPort)
10195
RETVAL_LONG(intern->host.port);
10296
}
10397

104-
/* Returns the reply document associated with the event */
10598
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getReply)
10699
{
107100
php_phongo_commandsucceededevent_t* intern;
@@ -121,7 +114,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getReply)
121114
RETURN_ZVAL(&state.zchild, 0, 1);
122115
}
123116

124-
/* Returns the event's request ID */
125117
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getRequestId)
126118
{
127119
php_phongo_commandsucceededevent_t* intern;
@@ -135,7 +127,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getRequestId)
135127
RETVAL_STRING(request_id);
136128
}
137129

138-
/* Returns the Server from which the event originated */
139130
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getServer)
140131
{
141132
php_phongo_commandsucceededevent_t* intern;
@@ -147,7 +138,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getServer)
147138
phongo_server_init(return_value, &intern->manager, intern->server_id);
148139
}
149140

150-
/* Returns the event's service ID */
151141
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getServiceId)
152142
{
153143
php_phongo_commandsucceededevent_t* intern = Z_COMMANDSUCCEEDEDEVENT_OBJ_P(getThis());
@@ -161,7 +151,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getServiceId)
161151
phongo_objectid_new(return_value, &intern->service_id);
162152
}
163153

164-
/* Returns the event's server connection ID */
165154
static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getServerConnectionId)
166155
{
167156
php_phongo_commandsucceededevent_t* intern = Z_COMMANDSUCCEEDEDEVENT_OBJ_P(getThis());
@@ -182,12 +171,6 @@ static PHP_METHOD(MongoDB_Driver_Monitoring_CommandSucceededEvent, getServerConn
182171
RETURN_LONG(intern->server_connection_id);
183172
}
184173

185-
/**
186-
* Event thrown when a command has succeeded to execute.
187-
*
188-
* This class is only constructed internally.
189-
*/
190-
191174
/* MongoDB\Driver\Monitoring\CommandSucceededEvent object handlers */
192175
static zend_object_handlers php_phongo_handler_commandsucceededevent;
193176

0 commit comments

Comments
 (0)