From ca73534d7ecf5bd2afad29e12f398e011c34c2ae Mon Sep 17 00:00:00 2001 From: winlin Date: Tue, 13 Oct 2015 11:27:39 +0800 Subject: [PATCH] refine comments for api key --- trunk/src/protocol/srs_kafka_stack.hpp | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/trunk/src/protocol/srs_kafka_stack.hpp b/trunk/src/protocol/srs_kafka_stack.hpp index e5df62b68..4be61c3eb 100644 --- a/trunk/src/protocol/srs_kafka_stack.hpp +++ b/trunk/src/protocol/srs_kafka_stack.hpp @@ -33,7 +33,10 @@ #ifdef SRS_AUTO_KAFKA -// https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-ApiKeys +/** + * the api key used to identify the request type. + * @see https://cwiki.apache.org/confluence/display/KAFKA/A+Guide+To+The+Kafka+Protocol#AGuideToTheKafkaProtocol-ApiKeys + */ enum SrsKafkaApiKey { SrsKafkaApiKeyProduceRequest = 0, @@ -178,7 +181,7 @@ public: */ virtual int header_size(); /** - * the size of message, the left bytes left after the header. + * the size of message, the bytes left after the header. * @remark total_size = 4 + header_size + message_size. */ virtual int message_size();