From a36d8ff7b96408f3da27e720d9c77e044b75dd75 Mon Sep 17 00:00:00 2001
From: Nikolai Nosov <nnosov@gmail.com>
Date: Thu, 16 Apr 2020 20:23:03 +0400
Subject: [PATCH] update information about pst interface

---
 include/libpst.h | 9 ++++++++-
 tests/main.c     | 1 +
 2 files changed, 9 insertions(+), 1 deletion(-)

diff --git a/include/libpst.h b/include/libpst.h
index b3fcd87..aadb59e 100644
--- a/include/libpst.h
+++ b/include/libpst.h
@@ -12,7 +12,6 @@
 
 //system
 #include <ucontext.h>
-#include <stdio.h>
 #include <stdint.h>
 
 #include "libpst-types.h"
@@ -21,6 +20,10 @@ typedef struct pst_handler pst_handler;
 typedef struct pst_function pst_function;
 typedef struct pst_parameter pst_parameter;
 
+//
+// Initialization of the library
+//
+
 /**
  * @brief allocate libpst handler and initialize the library
  * @param context context of process given to signal handler of a program. If NULL, then we are not in signal handler
@@ -37,6 +40,10 @@ pst_handler* pst_lib_init(ucontext_t* context, void* buff, uint32_t size);
  */
 void pst_lib_fini(pst_handler* handler);
 
+//
+// Basic unwind routines.
+// Allows to retrieve stack trace information about function's name, line and file if possibly
+//
 
 /**
  * @brief Unwinds current stack trace using base information about program (i.e. function address, function name and line)
diff --git a/tests/main.c b/tests/main.c
index e6466b8..436534d 100644
--- a/tests/main.c
+++ b/tests/main.c
@@ -2,6 +2,7 @@
 #include <stdlib.h>
 #include <fcntl.h>
 #include <stdint.h>
+#include <stdio.h>
 
 #include "../include/libpst.h"