Cześć,
Funkcje w C opisuję w następujący sposób:
/**
* @brief Function to detects short or long press;
*
* @param key_pin_state - actual pin state connected with key.
*
* @return KEY_state_t - function returns actual key state.
*/
Jak opisywać struktyry, enumy, define?
Wystarczy sam brief?
/**
* @brief Buffer structure.
*/
Druga rzecz to wartości zwracane przez funkcje. Lepiej stosować enumy czy int8_t?
int8_t Ring_buffer_init(Ring_buffer_t *ring_buffer, uint32_t size)
{
ring_buffer->buffer = (char*) malloc(size*sizeof(char));
if(ring_buffer->buffer == NULL)
{
return -1;
}
ring_buffer->set_size = size;
ring_buffer->actual_size = 0;
ring_buffer->read_ptr = 0;
ring_buffer->write_ptr = 0;
return 0;
}
czy
RING_BUFFER_t Ring_buffer_init(Ring_buffer_t *ring_buffer, uint32_t size)
{
ring_buffer->buffer = (char*) malloc(size*sizeof(char));
if(ring_buffer->buffer == NULL)
{
return RING_BUFFER_ERROR;
}
ring_buffer->set_size = size;
ring_buffer->actual_size = 0;
ring_buffer->read_ptr = 0;
ring_buffer->write_ptr = 0;
return RING_BUFFER_OK;
}