Doxygen documentation corrected and completed.

This commit is contained in:
Celine Mercier
2015-09-30 12:03:46 +02:00
parent 45af8396b8
commit 4b7f2d268b
25 changed files with 670 additions and 689 deletions

View File

@ -1,15 +1,22 @@
/*
* littlebigman.h
*
* Created on: 23 mai 2015
* Author: coissac
/****************************************************************************
* Header file for endianness checking *
****************************************************************************/
/**
* @file obilittlebigman.h
* @author Eric Coissac (eric.coissac@metabarcoding.org)
* @date 23 May 2015
* @brief Header file for endianness checking.
*/
#ifndef OBILITTLEBIGMAN_H_
#define OBILITTLEBIGMAN_H_
#include <stdbool.h>
/**
* Test if the architecture of the processor is little endian.
*
@ -41,7 +48,7 @@
* In this architecture, the last address is
* used to store the byte of lighter weight (LITTLE ENDian)
*
* @return a `bool` value:
* @returns a `bool` value:
* - `true` if the architecture is little endian
* - `false` if the architecture is big endian
*