summaryrefslogtreecommitdiff
path: root/src/lib/spy/spy_line.c
diff options
context:
space:
mode:
authorGuillaume Friloux <guillaume.friloux@gmail.com>2014-01-02 11:03:55 +0100
committerGuillaume Friloux <guillaume.friloux@gmail.com>2014-01-02 11:03:55 +0100
commit9f805a152e0d77646b962e83c3d17cc0113477c7 (patch)
treef678b38d98ddc8c53d3333dbd95eddad292344b1 /src/lib/spy/spy_line.c
parent91c142dd2efc4c66916c5ce849d2ddfa6f3b7073 (diff)
Improve documentation.
Diffstat (limited to '')
-rw-r--r--src/lib/spy/spy_line.c13
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 @@
5 * @{ 5 * @{
6 */ 6 */
7 7
8/**
9 * @brief Returns the line parsed by spy.
10 * @param sl Spy_Line structure.
11 * @return Pointer to parsed line.
12 *
13 * The pointer returned is the internal pointer of the Spy_Line,
14 * so, do not free it!
15 */
8const char * 16const char *
9spy_line_get(Spy_Line *sl) 17spy_line_get(Spy_Line *sl)
10{ 18{
11 return sl->line; 19 return sl->line;
12} 20}
13 21
22/**
23 * @brief Return the Spy_File of a Spy_Line.
24 * @param sl Spy_Line structure.
25 * @return Pointer to the Spy_File structure.
26 */
14Spy_File * 27Spy_File *
15spy_line_spyfile_get(Spy_Line *sl) 28spy_line_spyfile_get(Spy_Line *sl)
16{ 29{