X-Git-Url: http://git.vanrenterghem.biz/R/project-using-kafka-in-R.git/blobdiff_plain/e8e58503421340ca929ad43e76ca0adccbbf815d..cd56abd373b7483ac7815e234bb7ef0dfb0dc261:/R/SubscribeKafkaTopic.R

diff --git a/R/SubscribeKafkaTopic.R b/R/SubscribeKafkaTopic.R
index 5e6976b..8ca0f62 100644
--- a/R/SubscribeKafkaTopic.R
+++ b/R/SubscribeKafkaTopic.R
@@ -1,3 +1,14 @@
+#' Subscribe Apache Kafka consumer to a topic using Confluent's REST Proxy API
+#' 
+#' \code{SubscribeKafkaTopic} subscribes an Apache Kafka consumer to a topic 
+#'   using the rest proxy api provided by Confluent.
+#' 
+#' @param consumer.base.uri The URI of the consumer created by \code{\link{CreateKafkaConsumer}}.
+#' @param topic A chr object with the topic to subscribe to.
+#' 
+#' @return If the operation succeeds, returns the response, which can be discarded.
+#'   If the operation fails, it might help out understanding what happened.
+#'   
 SubscribeKafkaTopic <- function(consumer.base.uri, topic) {
   response <- POST(url=paste(consumer.base.uri,
                              "subscription", sep="/"),