Adds doxygen

This commit is contained in:
Antoine Bartuccio 2016-12-28 17:22:02 +01:00
parent 30bac5cdfe
commit b2c6602cbc
4 changed files with 2433 additions and 28 deletions

1
.gitignore vendored
View File

@ -2,3 +2,4 @@ Libs/
*.o
*.exe
build/
Doc/

2406
DoxyFile Normal file

File diff suppressed because it is too large Load Diff

View File

@ -22,7 +22,7 @@ typedef struct List {
/**
* Create a new list
* @return a pointer of list
* @return List a pointer of list
*/
List * CreateList();
@ -30,8 +30,7 @@ List * CreateList();
* Insert an element at the begining of a list
* @param list pointer of a list
* @param data any type of data
* @param size size of the data
* @return status of the operation
* @return int status of the operation
*/
int unshift(List* list, cellElement* data);
@ -39,8 +38,7 @@ int unshift(List* list, cellElement* data);
* Insert an element at the end of a list
* @param list pointer of a list
* @param data any type of data
* @param size size of the data
* @return status of the operation
* @return int status of the operation
*/
int push(List* list, cellElement* data);
@ -48,7 +46,7 @@ int push(List* list, cellElement* data);
* Get an element in a given list
* @param list as a pointer
* @param nb the number of the element (can be negative)
* @return an element
* @return List an element
*/
ListElement * GetElement(List *list, int nb);
@ -56,43 +54,43 @@ ListElement * GetElement(List *list, int nb);
* Delete an element with a pointer of element in the list
* @param list as a pointer
* @param element of the list as a pointer
* @return status of the operation
* @return int status of the operation
*/
int PopPtnList(List *list, ListElement *element);
/**
* Delete an element with a position in the list
* @param list as a pointer
* @param position of the element
* @return status of the operation
* @param nb position of the element
* @return int status of the operation
*/
int RemoveElement(List *list, int nb);
/**
* Delete the first element of the list
* @param list as a pointer
* @return status of the operation
* @return int status of the operation
*/
int shift(List *list);
/**
* Delete the last element of the list
* @param list as a pointer
* @return status of the operation
* @return int status of the operation
*/
int pop(List *list);
/**
* Delete every elements in a list
* @param list as a pointer
* @return status of the operation
* @return int status of the operation
*/
int DeleteListContent(List *list);
/**
* Free a list
* @param list as a pointer
* @return status of the operation
* @return int status of the operation
*/
int FreeList(List *list);
@ -102,13 +100,13 @@ int FreeList(List *list);
* @param pos the pos value to find
* @return ListElement the found element can return NULL
*/
ListElement * GetElementPos(List *List, int pos);
ListElement * GetElementPos(List *list, int pos);
/**
* Delete the first element of a list with the given pos
* @param list as a pointer
* @param pos pos value of the element
* @return status of the operation
* @return int status of the operation
*/
int RemoveElementPos(List *list, int pos);
@ -117,7 +115,7 @@ int RemoveElementPos(List *list, int pos);
* @param list as a pointer
* @param eli an element to insert
* @param elp the previous element in the list
* @return status of the operation
* @return int status of the operation
*/
int InsertBeforeElement(List *list, ListElement *eli, ListElement *elp);
@ -126,7 +124,7 @@ int InsertBeforeElement(List *list, ListElement *eli, ListElement *elp);
* @param list as a pointer
* @param eli an element to insert
* @param elb the before element in the list
* @return status of the operation
* @return int status of the operation
*/
int InsertAfterElement(List *list, ListElement *eli, ListElement *elb);
@ -135,7 +133,7 @@ int InsertAfterElement(List *list, ListElement *eli, ListElement *elb);
* @param list as a pointer
* @param data cellElement to insert
* @param nb the position in list to find
* @return status of the operation
* @return int status of the operation
*/
int InsertBefore(List *list, cellElement *data, int nb);
@ -144,7 +142,7 @@ int InsertBefore(List *list, cellElement *data, int nb);
* @param list as a pointer
* @param data cellElement to insert
* @param nb the position in list to find
* @return status of the operation
* @return int status of the operation
*/
int InsertAfter(List *list, cellElement *data, int nb);
@ -153,7 +151,7 @@ int InsertAfter(List *list, cellElement *data, int nb);
* @param list as a pointer
* @param data cellElement to insert
* @param pos the first pos in list to find
* @return status of the operation
* @return int status of the operation
*/
int InsertBeforePos(List *list, cellElement *data, int pos);
@ -162,7 +160,7 @@ int InsertBeforePos(List *list, cellElement *data, int pos);
* @param list as a pointer
* @param data cellElement to insert
* @param pos the first pos in list to find
* @return status of the operation
* @return int status of the operation
*/
int InsertAfterPos(List *list, cellElement *data, int pos);

View File

@ -181,7 +181,7 @@ Matrix freeMatrix(Matrix matrix);
* between two successive horizontal elements in the input matrix
* @param m a Matrix
* @param operator a function
* @return matrix the copmuted matrix
* @return Matrix the copmuted matrix
*/
Matrix colSequenceOnMatrix(Matrix m, bool (operator)(bool, bool));
@ -191,7 +191,7 @@ Matrix colSequenceOnMatrix(Matrix m, bool (operator)(bool, bool));
* between two succesive vertical elements in the input matrix
* @param m a Matrix
* @param operator a function
* @return matrix the copmuted matrix
* @return Matrix the copmuted matrix
*/
Matrix rowSequenceOnMatrix(Matrix m, bool (operator)(bool, bool));
@ -200,7 +200,7 @@ Matrix rowSequenceOnMatrix(Matrix m, bool (operator)(bool, bool));
* M rows and N-1 columns were each element corresponds to the AND boolean operation
* between two successive horizontal elements in the input matrix
* @param m a Matrix
* @return matrix the copmuted matrix
* @return Matrix the copmuted matrix
*/
Matrix andColSequenceOnMatrix(Matrix m);
@ -209,7 +209,7 @@ Matrix andColSequenceOnMatrix(Matrix m);
* M rows and N-1 columns were each element corresponds to the OR boolean operation
* between two successive horizontal elements in the input matrix
* @param m a Matrix
* @return matrix the copmuted matrix
* @return Matrix the copmuted matrix
*/
Matrix orColSequenceOnMatrix(Matrix m);
@ -218,7 +218,7 @@ Matrix orColSequenceOnMatrix(Matrix m);
* M-1 rows and N columns were each element corresponds to the AND boolean operation
* between two succesive vertical elements in the input matrix
* @param m a Matrix
* @return matrix the copmuted matrix
* @return Matrix the copmuted matrix
*/
Matrix andRowSequenceOnMatrix(Matrix m);
@ -227,7 +227,7 @@ Matrix andRowSequenceOnMatrix(Matrix m);
* M-1 rows and N columns were each element corresponds to the OR boolean operation
* between two succesive vertical elements in the input matrix
* @param m a Matrix
* @return matrix the copmuted matrix
* @return Matrix the copmuted matrix
*/
Matrix orRowSequenceOnMatrix(Matrix m);
@ -236,7 +236,7 @@ Matrix orRowSequenceOnMatrix(Matrix m);
* @param m a matrix
* @param n the number of rules
* @param rules an array of rules
* @return matrix a new modified matrix
* @return Matrix a new modified matrix
*/
Matrix matrixFromRules(Matrix m, int n, int rules[]);