Skip to content

Commit

Permalink
Added some documentation comments to arithmo.h
Browse files Browse the repository at this point in the history
  • Loading branch information
vstan02 committed Jul 17, 2023
1 parent c235f35 commit 776c4b9
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions include/arithmo.h
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,26 @@ struct artm_result {
} as;
};

/**
* @brief Initializes an Arithmo Interpreter object
* @param decl_table_size The approximate number of variables that will be used
* @return The Arithmo Interpreter object
*/
extern artm_calc_t* artm_calc_init(size_t decl_table_size);

/**
* @brief Deallocates the memory previously allocated by a call to artm_calc_init
* @param calc An Arithmo Interpreter object
* @return Void
*/
extern void artm_calc_free(artm_calc_t* calc);

/**
* @brief Evaluates the given mathematical expression
* @param calc An Arithmo Interpreter object
* @param expression The mathematical expression
* @return The evaluation result
*/
extern artm_result_t artm_calc_process(artm_calc_t* calc, const char* expression);

#endif // ARITHMO_H

0 comments on commit 776c4b9

Please sign in to comment.