Skip to content

Commit 577825e

Browse files
committed
Fix doxygen formatting errors in InnoDB memcached.
1 parent 55670c5 commit 577825e

File tree

6 files changed

+34
-17
lines changed

6 files changed

+34
-17
lines changed

plugin/innodb_memcached/daemon_memcached/engines/default_engine/items.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ struct items {
4747
* @param flags the flags in the new item
4848
* @param exptime when the object should expire
4949
* @param nbytes the number of bytes in the body for the item
50+
* @param cookie cookie provided by the core to identify the client
5051
* @return a pointer to an item on success NULL otherwise
5152
*/
5253
hash_item *item_alloc(struct default_engine *engine,
@@ -146,6 +147,7 @@ hash_item *touch_item(struct default_engine *engine,
146147
* @param item the item to store
147148
* @param cas the cas value (OUT)
148149
* @param operation what kind of store operation is this (ADD/SET etc)
150+
* @param cookie cookie provided by the core to identify the client
149151
* @return ENGINE_SUCCESS on success
150152
*
151153
* @todo should we refactor this into hash_item ** and remove the cas

plugin/innodb_memcached/daemon_memcached/programs/testapp.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,7 @@ static enum test_return test_safe_strtof(void) {
312312
* listening on
313313
* @param daemon set to true if you want to run the memcached server
314314
* as a daemon process
315+
* @param timeout
315316
* @return the pid of the memcached server
316317
*/
317318
static pid_t start_server(in_port_t *port_out, bool daemon, int timeout) {

plugin/innodb_memcached/innodb_memcache/include/innodb_api.h

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/***********************************************************************
22
3-
Copyright (c) 2011, 2016, Oracle and/or its affiliates. All rights reserved.
3+
Copyright (c) 2011, 2017, Oracle and/or its affiliates. All rights reserved.
44
55
This program is free software; you can redistribute it and/or modify it
66
under the terms of the GNU General Public License as published by the
@@ -345,7 +345,8 @@ ib_err_t
345345
innodb_cb_read_row(
346346
/*===============*/
347347
ib_crsr_t ib_crsr, /*!< in: InnoDB cursor instance */
348-
ib_tpl_t ib_tpl); /*!< out: read cols into this tuple */
348+
ib_tpl_t ib_tpl /*!< out: read cols into this tuple */
349+
);
349350

350351
/*****************************************************************//**
351352
Get a column type, length and attributes from the tuple.

plugin/innodb_memcached/innodb_memcache/include/innodb_config.h

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,7 +246,8 @@ bool
246246
innodb_verify(
247247
/*==========*/
248248
meta_cfg_info_t* info, /*!< in: meta info structure */
249-
void* thd); /*!< in/out: MySQL THD */
249+
void* thd /*!< in/out: MySQL THD */
250+
);
250251

251252
/**********************************************************************//**
252253
This function frees meta info structure */

plugin/innodb_memcached/innodb_memcache/src/innodb_api.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/***********************************************************************
22
3-
Copyright (c) 2011, 2016, Oracle and/or its affiliates. All rights reserved.
3+
Copyright (c) 2011, 2017, Oracle and/or its affiliates. All rights reserved.
44
55
This program is free software; you can redistribute it and/or modify it
66
under the terms of the GNU General Public License as published by the
@@ -690,7 +690,7 @@ innodb_api_search(
690690
ib_tpl_t* r_tpl, /*!< in: tpl for other DML
691691
operations */
692692
bool sel_only, /*!< in: for select only */
693-
innodb_range_key_t* range_key)/* search mode if not exact search */
693+
innodb_range_key_t* range_key)/*!< in: search mode if not exact search */
694694
{
695695
ib_err_t err = DB_SUCCESS;
696696
meta_cfg_info_t* meta_info = cursor_data->conn_meta;

plugin/innodb_memcached/innodb_memcache/src/innodb_engine_private.h

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ innodb_initialize(
5151
/*==============*/
5252
ENGINE_HANDLE* handle, /*!< in/out: InnoDB memcached
5353
engine */
54-
const char* config_str); /*!< in: configure string */
54+
const char* config_str /*!< in: configure string */
55+
);
5556

5657
/*******************************************************************//**
5758
Allocate gets a struct item from the slab allocator, and fills in
@@ -69,7 +70,8 @@ innodb_allocate(
6970
const size_t nkey, /*!< in: key length */
7071
const size_t nbytes, /*!< in: value length */
7172
const int flags, /*!< in: flag */
72-
const rel_time_t exptime); /*!< in: expiration time */
73+
const rel_time_t exptime /*!< in: expiration time */
74+
);
7375

7476
/*******************************************************************//**
7577
Cleanup connections
@@ -83,8 +85,9 @@ innodb_remove(
8385
const void* key, /*!< in: key value */
8486
const size_t nkey, /*!< in: key length */
8587
uint64_t cas, /*!< in: cas */
86-
uint16_t vbucket); /*!< in: bucket, used by default
88+
uint16_t vbucket /*!< in: bucket, used by default
8789
engine only */
90+
);
8891

8992
/*******************************************************************//**
9093
bind table
@@ -96,7 +99,8 @@ innodb_bind(
9699
ENGINE_HANDLE* handle, /*!< in: Engine handle */
97100
const void* cookie, /*!< in: connection cookie */
98101
const void* name, /*!< in: table ID name */
99-
const size_t name_len); /*!< in: name length */
102+
const size_t name_len /*!< in: name length */
103+
);
100104

101105
/*******************************************************************//**
102106
release */
@@ -106,7 +110,8 @@ innodb_release(
106110
/*===========*/
107111
ENGINE_HANDLE* handle, /*!< in: Engine handle */
108112
const void* cookie, /*!< in: connection cookie */
109-
item* item); /*!< in: item to free */
113+
item* item /*!< in: item to free */
114+
);
110115

111116
/*******************************************************************//**
112117
release */
@@ -116,7 +121,8 @@ innodb_clean_engine(
116121
/*================*/
117122
ENGINE_HANDLE* handle, /*!< in: Engine handle */
118123
const void* cookie, /*!< in: connection cookie */
119-
void* conn); /*!< in: item to free */
124+
void* conn /*!< in: item to free */
125+
);
120126
/*******************************************************************//**
121127
Free value assocaited with key */
122128
static
@@ -136,8 +142,9 @@ innodb_get(
136142
item** item, /*!< out: item to fill */
137143
const void* key, /*!< in: search key */
138144
const int nkey, /*!< in: key length */
139-
uint16_t vbucket); /*!< in: bucket, used by default
145+
uint16_t vbucket /*!< in: bucket, used by default
140146
engine only */
147+
);
141148

142149
/*******************************************************************//**
143150
Get statistics info
@@ -150,7 +157,8 @@ innodb_get_stats(
150157
const void* cookie, /*!< in: connection cookie */
151158
const char* stat_key, /*!< in: statistics key */
152159
int nkey, /*!< in: key length */
153-
ADD_STAT add_stat); /*!< out: stats to fill */
160+
ADD_STAT add_stat /*!< out: stats to fill */
161+
);
154162

155163
/*******************************************************************//**
156164
reset statistics
@@ -160,7 +168,8 @@ void
160168
innodb_reset_stats(
161169
/*===============*/
162170
ENGINE_HANDLE* handle, /*!< in: Engine Handle */
163-
const void* cookie); /*!< in: connection cookie */
171+
const void* cookie /*!< in: connection cookie */
172+
);
164173

165174
/*******************************************************************//**
166175
API interface for memcached's "SET", "ADD", "REPLACE", "APPEND"
@@ -175,8 +184,9 @@ innodb_store(
175184
item* item, /*!< out: result to fill */
176185
uint64_t* cas, /*!< in: cas value */
177186
ENGINE_STORE_OPERATION op, /*!< in: type of operation */
178-
uint16_t vbucket); /*!< in: bucket, used by default
187+
uint16_t vbucket /*!< in: bucket, used by default
179188
engine only */
189+
);
180190

181191
/*******************************************************************//**
182192
Support memcached "FLUSH_ALL" command, clean up storage (trunate InnoDB Table)
@@ -187,8 +197,9 @@ innodb_flush(
187197
/*=========*/
188198
ENGINE_HANDLE* handle, /*!< in: Engine Handle */
189199
const void* cookie, /*!< in: connection cookie */
190-
time_t when); /*!< in: when to flush, not used by
200+
time_t when /*!< in: when to flush, not used by
191201
InnoDB */
202+
);
192203

193204
/*******************************************************************//**
194205
Deal with unknown command. Currently not used
@@ -200,6 +211,7 @@ innodb_unknown_command(
200211
ENGINE_HANDLE* handle, /*!< in: Engine Handle */
201212
const void* cookie, /*!< in: connection cookie */
202213
protocol_binary_request_header *request, /*!< in: request */
203-
ADD_RESPONSE response); /*!< out: respondse */
214+
ADD_RESPONSE response /*!< out: respondse */
215+
);
204216

205217
#endif /* innodb_engine_private_h */

0 commit comments

Comments
 (0)