summaryrefslogtreecommitdiff
path: root/include/yaml/yaml.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/yaml/yaml.h')
-rw-r--r--include/yaml/yaml.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/include/yaml/yaml.h b/include/yaml/yaml.h
index eecfe10..64412c7 100644
--- a/include/yaml/yaml.h
+++ b/include/yaml/yaml.h
@@ -1,3 +1,12 @@
+/**
+ * @file yaml.h
+ * @brief Public interface for libyaml.
+ *
+ * Include the header file with
+ * @code
+ * #include <yaml/yaml.h>
+ * @endcode
+ */
#ifndef YAML_H
#define YAML_H