Fix doxygen documentation

edenhill · edenhill · commit 07e6a8bdf7dc · 2019-03-14T17:35:07.000+01:00
diff --git a/CONFIGURATION.md b/CONFIGURATION.md
@@ -1,4 +1,4 @@
-//@file
+# Configuration properties
 ## Global configuration properties
 
 Property                                 | C/P | Range           |       Default | Importance | Description              
diff --git a/INTRODUCTION.md b/INTRODUCTION.md
@@ -1,4 +1,3 @@
-//@file INTRODUCTION.md
 # Introduction to librdkafka - the Apache Kafka C/C++ client library
 
 
diff --git a/Makefile b/Makefile
@@ -21,7 +21,7 @@ libs:
 
 CONFIGURATION.md: src/rdkafka.h examples
 	@printf "$(MKL_YELLOW)Updating$(MKL_CLR_RESET)\n"
-	@echo '//@file' > CONFIGURATION.md.tmp
+	@echo "# Configuration properties" > CONFIGURATION.md.tmp
 	@(examples/rdkafka_performance -X list >> CONFIGURATION.md.tmp; \
 		cmp CONFIGURATION.md CONFIGURATION.md.tmp || \
 		mv CONFIGURATION.md.tmp CONFIGURATION.md; \
diff --git a/STATISTICS.md b/STATISTICS.md
@@ -221,7 +221,8 @@ This (prettified) example output is from a short-lived producer using the follow
 
 Note: this output is prettified using `jq .`, the JSON object emitted by librdkafka does not contain line breaks.
 
-```{
+```json
+{
   "name": "rdkafka#producer-1",
   "client_id": "rdkafka",
   "type": "producer",
diff --git a/mainpage.doxy b/mainpage.doxy
@@ -5,24 +5,29 @@
  *
  * @section intro Introduction
  *
- * For an introduction and manual to librdkafka see INTRODUCTION.md
+ * For an introduction and manual to librdkafka see \ref INTRODUCTION.md
  *
  * @section conf Configuration
  *
  * librdkafka is highly configurable to meet any deployment demands.
  * It is usually safe to leave most configuration properties to their default
  * values.
  *
- * See CONFIGURATION.md for the full list of supported configuration properties.
- *
+ * See \ref CONFIGURATION.md for the full list of supported configuration properties.
+*
  * @remark Application developers are recommended to provide a non-hardcoded
  *         interface to librdkafka's string based name-value configuration
  *         property interface, allowing users to configure any librdkafka
  *         property directly without alterations to the application.
  *         This allows for seamless upgrades where linking to a new version
  *         of librdkafka automatically provides new configuration
  *         based features.
-
+ *
+ * @section stats Statistics
+ *
+ * librdkafka provides detailed metrics through its statistics interface.
+ *
+ * See \ref STATISTICS.md and \ref rd_kafka_conf_set_stats_cb.
  *
  * @section c_api C API
  *

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-//@file`
	`1`	`+# Configuration properties`
`2`	`2`	`## Global configuration properties`
`3`	`3`
`4`	`4`	`Property \| C/P \| Range \| Default \| Importance \| Description`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,3 @@`
`1`		`-//@file INTRODUCTION.md`
`2`	`1`	`# Introduction to librdkafka - the Apache Kafka C/C++ client library`
`3`	`2`
`4`	`3`
Original file line number	Diff line number	Diff line change
`@@ -5,24 +5,29 @@`
`5`	`5`	`*`
`6`	`6`	`* @section intro Introduction`
`7`	`7`	`*`
`8`		`- * For an introduction and manual to librdkafka see INTRODUCTION.md`
	`8`	`+ * For an introduction and manual to librdkafka see \ref INTRODUCTION.md`
`9`	`9`	`*`
`10`	`10`	`* @section conf Configuration`
`11`	`11`	`*`
`12`	`12`	`* librdkafka is highly configurable to meet any deployment demands.`
`13`	`13`	`* It is usually safe to leave most configuration properties to their default`
`14`	`14`	`* values.`
`15`	`15`	`*`
`16`		`- * See CONFIGURATION.md for the full list of supported configuration properties.`
`17`		`- *`
	`16`	`+ * See \ref CONFIGURATION.md for the full list of supported configuration properties.`
	`17`	`+*`
`18`	`18`	`* @remark Application developers are recommended to provide a non-hardcoded`
`19`	`19`	`* interface to librdkafka's string based name-value configuration`
`20`	`20`	`* property interface, allowing users to configure any librdkafka`
`21`	`21`	`* property directly without alterations to the application.`
`22`	`22`	`* This allows for seamless upgrades where linking to a new version`
`23`	`23`	`* of librdkafka automatically provides new configuration`
`24`	`24`	`* based features.`
`25`		`-`
	`25`	`+ *`
	`26`	`+ * @section stats Statistics`
	`27`	`+ *`
	`28`	`+ * librdkafka provides detailed metrics through its statistics interface.`
	`29`	`+ *`
	`30`	`+ * See \ref STATISTICS.md and \ref rd_kafka_conf_set_stats_cb.`
`26`	`31`	`*`
`27`	`32`	`* @section c_api C API`
`28`	`33`	`*`