Doxygen documentation corrected and completed.
This commit is contained in:
@ -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
|
||||
*
|
||||
|
Reference in New Issue
Block a user