Skip to content

Commit

Permalink
Doxygen formatting fixes
Browse files Browse the repository at this point in the history 
sections don't really work across functions as I had hoped.

* A bunch of whitespace cleanups.
* Remove outdated Doxyfile config
  • Loading branch information
@edenhill
edenhill committed Apr 16, 2020
1 parent 2590e9c commit 57e7b4d
Show file tree
Hide file tree
Showing 3 changed files with 99 additions and 114 deletions.
15 changes: 0 additions & 15 deletions Doxyfile
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2073,12 +2073,6 @@ EXTERNAL_GROUPS = YES

EXTERNAL_PAGES = YES

# The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl').
# The default file (with absolute path) is: /usr/bin/perl.

PERL_PATH = /usr/bin/perl

#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
Expand All @@ -2092,15 +2086,6 @@ PERL_PATH = /usr/bin/perl

CLASS_DIAGRAMS = YES

# You can define message sequence charts within doxygen comments using the \msc
# command. Doxygen will then run the mscgen tool (see:
# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
# documentation. The MSCGEN_PATH tag allows you to specify the directory where
# the mscgen tool resides. If left empty the tool is assumed to be found in the
# default search path.

MSCGEN_PATH =

# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
Expand Down
80 changes: 40 additions & 40 deletions src-cpp/rdkafkacpp.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -648,7 +648,7 @@ class RD_EXPORT DeliveryReportCb {
* The callback should invoke RdKafka::oauthbearer_set_token() or
* RdKafka::oauthbearer_set_token_failure() to indicate success or failure,
* respectively.
*
*
* The refresh operation is eventable and may be received when an event
* callback handler is set with an event type of
* \c RdKafka::Event::EVENT_OAUTHBEARER_TOKEN_REFRESH.
Expand Down Expand Up @@ -1495,7 +1495,7 @@ class RD_EXPORT Handle {
*
* @returns The fetch queue for the given partition if successful. Else,
* NULL is returned.
*
*
* @remark This function only works on consumers.
*/
virtual Queue *get_partition_queue (const TopicPartition *partition) = 0;
Expand Down Expand Up @@ -1629,10 +1629,10 @@ class RD_EXPORT Handle {
* this method upon success. The extension keys must not include the reserved
* key "`auth`", and all extension keys and values must conform to the
* required format as per https://tools.ietf.org/html/rfc7628#section-3.1:
*
*
* key = 1*(ALPHA)
* value = *(VCHAR / SP / HTAB / CR / LF )
*
*
* @returns \c RdKafka::ERR_NO_ERROR on success, otherwise \p errstr set
* and:<br>
* \c RdKafka::ERR__INVALID_ARG if any of the arguments are
Expand All @@ -1641,7 +1641,7 @@ class RD_EXPORT Handle {
* supported by this build;<br>
* \c RdKafka::ERR__STATE if SASL/OAUTHBEARER is supported but is
* not configured as the client's authentication mechanism.<br>
*
*
* @sa RdKafka::oauthbearer_set_token_failure
* @sa RdKafka::Conf::set() \c "oauthbearer_token_refresh_cb"
*/
Expand Down Expand Up @@ -1854,7 +1854,7 @@ class RD_EXPORT MessageTimestamp {
* Represents message headers.
*
* https://cwiki.apache.org/confluence/display/KAFKA/KIP-82+-+Add+Record+Headers
*
*
* @remark Requires Apache Kafka >= 0.11.0 brokers
*/
class RD_EXPORT Headers {
Expand Down Expand Up @@ -1995,24 +1995,24 @@ class RD_EXPORT Headers {

/**
* @brief Create a new instance of the Headers object
*
*
* @returns an empty Headers list
*/
static Headers *create();

/**
* @brief Create a new instance of the Headers object from a std::vector
*
*
* @param headers std::vector of RdKafka::Headers::Header objects.
* The headers are copied, not referenced.
*
*
* @returns a Headers list from std::vector set to the size of the std::vector
*/
static Headers *create(const std::vector<Header> &headers);

/**
* @brief Adds a Header to the end of the list.
*
*
* @param key header key/name
* @param value binary value, or NULL
* @param value_size size of the value
Expand All @@ -2026,10 +2026,10 @@ class RD_EXPORT Headers {
* @brief Adds a Header to the end of the list.
*
* Convenience method for adding a std::string as a value for the header.
*
*
* @param key header key/name
* @param value value string
*
*
* @returns an ErrorCode signalling success or failure to add the header.
*/
virtual ErrorCode add(const std::string &key, const std::string &value) = 0;
Expand All @@ -2047,18 +2047,18 @@ class RD_EXPORT Headers {

/**
* @brief Removes all the Headers of a given key
*
*
* @param key header key/name to remove
*
*
* @returns An ErrorCode signalling a success or failure to remove the Header.
*/
virtual ErrorCode remove(const std::string &key) = 0;

/**
* @brief Gets all of the Headers of a given key
*
*
* @param key header key/name
*
*
* @remark If duplicate keys exist this will return them all as a std::vector
*
* @returns a std::vector containing all the Headers of the given key.
Expand All @@ -2067,9 +2067,9 @@ class RD_EXPORT Headers {

/**
* @brief Gets the last occurrence of a Header of a given key
*
*
* @param key header key/name
*
*
* @remark This will only return the most recently added header
*
* @returns the Header if found, otherwise a Header with an err set to
Expand Down Expand Up @@ -2107,20 +2107,20 @@ class RD_EXPORT Message {
/** @brief Message persistence status can be used by the application to
* find out if a produced message was persisted in the topic log. */
enum Status {
/**< Message was never transmitted to the broker, or failed with
* an error indicating it was not written to the log.
* Application retry risks ordering, but not duplication. */
/** Message was never transmitted to the broker, or failed with
* an error indicating it was not written to the log.
* Application retry risks ordering, but not duplication. */
MSG_STATUS_NOT_PERSISTED = 0,

/**< Message was transmitted to broker, but no acknowledgement was
* received.
* Application retry risks ordering and duplication. */
/** Message was transmitted to broker, but no acknowledgement was
* received.
* Application retry risks ordering and duplication. */
MSG_STATUS_POSSIBLY_PERSISTED = 1,

/**< Message was written to the log and fully acknowledged.
* No reason for application to retry.
* Note: this value should only be trusted with \c acks=all. */
MSG_STATUS_PERSISTED = 2
/** Message was written to the log and fully acknowledged.
* No reason for application to retry.
* Note: this value should only be trusted with \c acks=all. */
MSG_STATUS_PERSISTED = 2,
};

/**
Expand Down Expand Up @@ -2250,7 +2250,7 @@ class RD_EXPORT Queue {
* If \p dst is \c NULL, the forwarding is removed.
*
* The internal refcounts for both queues are increased.
*
*
* @remark Regardless of whether \p dst is NULL or not, after calling this
* function, \p src will not forward it's fetch queue to the consumer
* queue.
Expand Down Expand Up @@ -2893,7 +2893,7 @@ class RD_EXPORT Producer : public virtual Handle {
* Messages are considered in-queue from the point they
* are accepted by produce() until their corresponding
* delivery report callback/event returns.
* It is thus a requirement to call
* It is thus a requirement to call
* poll() (or equiv.) from a separate
* thread when RK_MSG_BLOCK is used.
* See WARNING on \c RK_MSG_BLOCK above.
Expand Down Expand Up @@ -3298,18 +3298,18 @@ class Metadata {
typedef TopicMetadataVector::const_iterator TopicMetadataIterator;


/**
* @brief Broker list
* @remark Ownership of the returned pointer is retained by the instance of
* Metadata that is called.
*/
/**
* @brief Broker list
* @remark Ownership of the returned pointer is retained by the instance of
* Metadata that is called.
*/
virtual const BrokerMetadataVector *brokers() const = 0;

/**
* @brief Topic list
* @remark Ownership of the returned pointer is retained by the instance of
* Metadata that is called.
*/
/**
* @brief Topic list
* @remark Ownership of the returned pointer is retained by the instance of
* Metadata that is called.
*/
virtual const TopicMetadataVector *topics() const = 0;

/** @brief Broker (id) originating this metadata */
Expand Down
Loading

0 comments on commit 57e7b4d

Please sign in to comment.