danisanti
/
numericx
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doxygen refactor 

* removed doxygen comments from header file
 * change the title of README.md from better understanding in doxygen
   doc
 * removed all files from doc/ and rebuild the doc

Signed-off-by: Daniel Santos <dacs.git@brilhante.top>
This commit is contained in:
Daniel Santos 2022-03-18 14:28:39 +00:00
parent 47d229f3d9
commit a8f50b625c
3 changed files with 2 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -1,4 +1,4 @@
# Numericx
# Numericx Readme
A command-line interface (CLI) program that converts a number (or text) from one numerical system into another different numerical system.

2
doc

@ -1 +1 @@
Subproject commit 9ec76f1562e42d39d82898b16831d6a90dfb0d9d
Subproject commit 2fe4a7ab4b3ea7480675e752526944407f4c0731

31
numericx.h
View File

@ -27,40 +27,9 @@ typedef struct NumeralPtr
/* ||FUNCTIONS|| */
/**
* @brief Free numericx result.
*
* Free up the result string of numericx_translate(),
* after we are done with it.
*
* @param string - char pointer to be free.
*/
void
numericx_free(char* string);
/**
* @brief Translate string to a different numerical system.
*
* After definition of the 'from' numerical system proprieties and the
* 'to' numerical system proprieties, will be translate 'number' from the
* 'from' to the 'to' numerical system, resulting in a string.
*
* @param from - string with all the numerals of the number's numerical system.
* @param from_units_on_the_end - does the translate 'from' numerical system have units on the end (on the right)?
* @param from_first_number_void - does the translate 'from' numerical system start counting on the second number?
* @param from_infinite_base - is the translate 'from' numerical system first numeral infinite? For example, if first numeral is 'A', then does 'A' == 'AA' == 'AAA' == 'AAAA' ... ?
* @param to - string with all the numerals of the resulting number's numerical system.
* @param to_units_on_the_end - does the translate 'to' numerical system have units on the end (on the right)?
* @param to_first_number_void - does the translate 'to' numerical system start counting on the second number?
* @param to_infinite_base - is the translate 'to' numerical system first numeral infinite? For example, if first numeral is 'A', then does 'A' == 'AA' == 'AAA' == 'AAAA' ... ?
* @param number - number of the 'from' numerical system, to be translated into the 'to' numerical system.
* @param result_string - string to where to store the result.
*
* @return EINVAL if argument of result_string is not NULL.
* @return EDOM if number doesn't belong to the 'from' numerical system.
* @return ERANGE if the resulting number cannot be represented, because of a 'from' void number and a lack of void number in 'to'.
* @return EXIT_SUCCESS in case of success.
*/
int
numericx_translate(char* from, bool from_units_on_the_end, bool from_first_number_void, bool from_infinite_base, char* to, bool to_units_on_the_end, bool to_first_number_void, bool to_infinite_base, char* number, char** result_string);