Improve documentation.

1 files changed, 13 insertions, 0 deletions

diff --git a/src/lib/spy/spy_line.c b/src/lib/spy/spy_line.c
index b9c076b..6f1b800 100644
--- a/src/lib/spy/spy_line.c
+++ b/src/lib/spy/spy_line.c
@@ -5,12 +5,25 @@
  * @{
  */
 
+/**
+ * @brief Returns the line parsed by spy.
+ * @param sl Spy_Line structure.
+ * @return Pointer to parsed line.
+ *
+ * The pointer returned is the internal pointer of the Spy_Line,
+ * so, do not free it!
+ */
 const char *
 spy_line_get(Spy_Line *sl)
 {
    return sl->line;
 }
 
+/**
+ * @brief Return the Spy_File of a Spy_Line.
+ * @param sl Spy_Line structure.
+ * @return Pointer to the Spy_File structure.
+ */
 Spy_File *
 spy_line_spyfile_get(Spy_Line *sl)
 {