From ba90b681900894fd61319cc0cb6a4f4f963d1231 Mon Sep 17 00:00:00 2001
From: Krishna Vedala <7001608+kvedala@users.noreply.github.com>
Date: Sun, 31 May 2020 10:51:34 -0400
Subject: [PATCH] add params and returns to factorial_large_number

---
 misc/factorial_large_number.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/misc/factorial_large_number.c b/misc/factorial_large_number.c
index 6811abe4..68acfb37 100644
--- a/misc/factorial_large_number.c
+++ b/misc/factorial_large_number.c
@@ -18,6 +18,7 @@ typedef struct _large_num
 
 /**
  * create a new large number
+ * \returns pointer to a large number
  **/
 large_num *new_number(void)
 {
@@ -30,6 +31,7 @@ large_num *new_number(void)
 
 /**
  * delete all memory allocated for large number
+ * \param[in] num pointer to large_num to delete
  **/
 void delete_number(large_num *num)
 {
@@ -39,6 +41,8 @@ void delete_number(large_num *num)
 
 /**
  * add a digit to the large number
+ * \param[in,out] num
+ * \param[in] value value of the digit to insert
  **/
 void add_digit(large_num *num, unsigned int value)
 {