From 7bcacfecac9562b24d3375c2509875c8013420a3 Mon Sep 17 00:00:00 2001
From: Tim Schubert <mail@timschubert.net>
Date: Mon, 29 Oct 2018 11:00:56 +0100
Subject: [PATCH] Add documentation for parse()

---
 netcalc.c | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/netcalc.c b/netcalc.c
index 96b8cd4..23ab84a 100644
--- a/netcalc.c
+++ b/netcalc.c
@@ -120,6 +120,13 @@ int base(char *numstr, unsigned int *num) {
     }
 }
 
+/// Parses the client input into a command
+/// @param buf source buffer
+/// @param buflen length of source buffer
+/// @param first first operand
+/// @param second second operand
+/// @param op operator (+,-,*,/)
+/// @return 0 on success -1 on parser error, -2 on invalid values
 int parse(char *buf, size_t buflen, unsigned int *first, unsigned int *second, char *op) {
     char *num1str = NULL;
     char *num2str = NULL;