Skip to content

Commit 973fabb

Browse files
committed
lib/kafka, rlm_kafka: drop trailing periods from Doxygen block titles
House style: the brief / title line of a /** */ block is a heading, not a sentence, so no trailing period. Body prose sentences after the title keep their periods as normal.
1 parent 0f06153 commit 973fabb

3 files changed

Lines changed: 49 additions & 48 deletions

File tree

src/lib/kafka/base.c

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
* @{
3737
*/
3838

39-
/** Common parse path for a single CONF_PAIR's value.
39+
/** Common parse path for a single CONF_PAIR's value
4040
*
4141
* Handles librdkafka's preferred unit conventions (ms-integer for time
4242
* deltas, byte-integer for sizes, string "true"/"false" for bools) and
@@ -237,7 +237,7 @@ static int kafka_noop_parse(UNUSED TALLOC_CTX *ctx, UNUSED void *out, UNUSED voi
237237
* @{
238238
*/
239239

240-
/** Destructor on the talloc sentinel that owns the rd_kafka_conf_t handle.
240+
/** Destructor on the talloc sentinel that owns the rd_kafka_conf_t handle
241241
*
242242
* The sentinel is just a talloced `rd_kafka_conf_t *` attached to the
243243
* caller's parse ctx - when talloc unwinds the instance, this fires and
@@ -249,7 +249,7 @@ static int _kafka_conf_free(rd_kafka_conf_t **pconf)
249249
return 0;
250250
}
251251

252-
/** Fetch the `fr_kafka_conf_t` currently being populated by the parser.
252+
/** Fetch the `fr_kafka_conf_t` currently being populated by the parser
253253
*
254254
* The parser contract is that `base` points at the caller's instance
255255
* struct and `fr_kafka_conf_t` is its first member, so a reinterpret
@@ -441,7 +441,7 @@ int kafka_config_dflt(CONF_PAIR **out, void *parent, CONF_SECTION *cs, fr_token_
441441
return 0;
442442
}
443443

444-
/** Untyped passthrough: hand a CONF_PAIR's attr/value straight to rd_kafka_conf_set.
444+
/** Untyped passthrough: hand a CONF_PAIR's attr/value straight to rd_kafka_conf_set
445445
*
446446
* Used by the `CF_IDENT_ANY` entry in the base `properties { }` subsection
447447
* to accept arbitrary librdkafka properties that don't have a typed entry
@@ -485,7 +485,7 @@ static int _kafka_topic_conf_free(fr_kafka_topic_conf_t *ktc)
485485
return 0;
486486
}
487487

488-
/** Allocate a per-topic conf parented under `ctx`.
488+
/** Allocate a per-topic conf parented under `ctx`
489489
*
490490
* Used by the subsection hook to build each declared topic's
491491
* `fr_kafka_topic_conf_t`. The destructor releases the librdkafka
@@ -589,7 +589,7 @@ static int kafka_topic_config_dflt(CONF_PAIR **out, void *parent, CONF_SECTION *
589589
return 0;
590590
}
591591

592-
/** Topic-level counterpart to `kafka_config_raw_parse`.
592+
/** Topic-level counterpart to `kafka_config_raw_parse`
593593
*
594594
* Used inside a declared topic's `properties { }` subsection to accept
595595
* arbitrary `rd_kafka_topic_conf_set` properties. `base` is the enclosing
@@ -698,7 +698,7 @@ int kafka_topic_subsection_parse(TALLOC_CTX *ctx, void *out, void *base,
698698
* @{
699699
*/
700700

701-
/** `properties { ... }` escape-hatch contents.
701+
/** `properties { ... }` escape-hatch contents
702702
*
703703
* Accepts any `key = value` pair and hands it straight to
704704
* `rd_kafka_conf_set`. See `kafka_config_raw_parse`.
@@ -708,7 +708,7 @@ conf_parser_t const kafka_base_properties_config[] = {
708708
CONF_PARSER_TERMINATOR
709709
};
710710

711-
/** Per-topic `properties { ... }` escape-hatch contents.
711+
/** Per-topic `properties { ... }` escape-hatch contents
712712
*
713713
* Same idea as `kafka_base_properties_config`, but dispatches to
714714
* `rd_kafka_topic_conf_set` against the enclosing topic's conf.

src/lib/kafka/base.h

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ typedef struct {
5757
rd_kafka_topic_conf_t *rdtc;
5858
} fr_kafka_topic_conf_t;
5959

60-
/** Declared topic record - one per `topic { <name> { ... } }` subsection.
60+
/** Declared topic record - one per `topic { <name> { ... } }` subsection
6161
*
6262
* Built by the library's per-topic parse hook, indexed on the parent
6363
* `fr_kafka_conf_t.topics` tree. Callers typically retrieve via
@@ -71,7 +71,7 @@ struct fr_kafka_topic_s {
7171
fr_rb_node_t node;
7272
};
7373

74-
/** uctx attached to each entry in `KAFKA_BASE_PRODUCER_CONFIG`.
74+
/** uctx attached to each entry in `KAFKA_BASE_PRODUCER_CONFIG`
7575
*
7676
* Public so the config macro's struct literals resolve in caller TUs.
7777
* You only touch this directly if you're extending the library's
@@ -87,7 +87,7 @@ typedef struct {
8787
//!< Kafka uses ', ' or ';' seemingly at random.
8888
} fr_kafka_conf_ctx_t;
8989

90-
/** Generic librdkafka-property parser used by `KAFKA_BASE_PRODUCER_CONFIG` entries.
90+
/** Generic librdkafka-property parser used by `KAFKA_BASE_PRODUCER_CONFIG` entries
9191
*
9292
* Exposed so the macro's FR_CONF_PAIR_GLOBAL entries can reference it from any TU.
9393
*/
@@ -98,7 +98,7 @@ int kafka_config_parse(TALLOC_CTX *ctx, void *out, void *base, CONF_ITEM *ci, co
9898
*/
9999
int kafka_config_dflt(CONF_PAIR **out, void *parent, CONF_SECTION *cs, fr_token_t quote, conf_parser_t const *rule);
100100

101-
/** Untyped passthrough parser used by `KAFKA_RAW_CONFIG`.
101+
/** Untyped passthrough parser used by `KAFKA_RAW_CONFIG`
102102
*
103103
* Hands the CONF_PAIR's attribute/value straight to `rd_kafka_conf_set`.
104104
* No type dispatch - user is responsible for librdkafka-native units.
@@ -111,22 +111,22 @@ int kafka_config_raw_parse(TALLOC_CTX *ctx, void *out, void *base, CONF_ITEM *ci
111111
*/
112112
int kafka_topic_config_raw_parse(TALLOC_CTX *ctx, void *out, void *base, CONF_ITEM *ci, conf_parser_t const *rule);
113113

114-
/** Per-topic subsection hook used by KAFKA_PRODUCER_CONFIG / KAFKA_CONSUMER_CONFIG.
114+
/** Per-topic subsection hook used by KAFKA_PRODUCER_CONFIG / KAFKA_CONSUMER_CONFIG
115115
*
116116
* Runs the inner rules against each `topic { <name> { ... } }` block
117117
* then inserts an `fr_kafka_topic_t` into the parent `fr_kafka_conf_t.topics`
118118
* tree so callers can look topics up by name without re-walking CONF_SECTIONs.
119119
*/
120120
int kafka_topic_subsection_parse(TALLOC_CTX *ctx, void *out, void *base, CONF_ITEM *ci, conf_parser_t const *rule);
121121

122-
/** Look up a declared topic by name on an `fr_kafka_conf_t`.
122+
/** Look up a declared topic by name on an `fr_kafka_conf_t`
123123
*
124124
* @return the `fr_kafka_topic_t`, or NULL if no topic of that name was
125125
* declared (or if no topics have been parsed yet).
126126
*/
127127
fr_kafka_topic_t *kafka_topic_find(fr_kafka_conf_t const *kc, char const *name);
128128

129-
/** @name Nested config arrays referenced by `KAFKA_BASE_PRODUCER_CONFIG`.
129+
/** @name Nested config arrays referenced by `KAFKA_BASE_PRODUCER_CONFIG`
130130
*
131131
* Extern so the macro's FR_CONF_SUBSECTION_GLOBAL entries can name them
132132
* from any TU. Not part of the stable API - treat as implementation
@@ -145,7 +145,7 @@ extern conf_parser_t const kafka_base_properties_config[];
145145
extern conf_parser_t const kafka_base_topic_properties_config[];
146146
/** @} */
147147

148-
/** Config entries common to producer and consumer clients.
148+
/** Config entries common to producer and consumer clients
149149
*
150150
* Broker list, client identity, TLS / SASL, metadata / version /
151151
* connection tuning, debug / plugin knobs. Usually composed with a
@@ -190,7 +190,7 @@ extern conf_parser_t const kafka_base_topic_properties_config[];
190190
* the user writes librdkafka-native units (e.g. "500" for ms). */ \
191191
{ FR_CONF_SUBSECTION_GLOBAL("properties", 0, kafka_base_properties_config) }
192192

193-
/** Producer-only delta: librdkafka producer tuning + declared topics.
193+
/** Producer-only delta: librdkafka producer tuning + declared topics
194194
*
195195
* Compose with @ref KAFKA_BASE_CONFIG. Callers must embed
196196
* `fr_kafka_conf_t` as the first member of their instance struct so

0 commit comments

Comments
 (0)