obitools/obitools3
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 66 Wiki Activity

fixed typos and other minor things

Browse Source
This commit is contained in:
Celine Mercier
2015-06-10 15:19:02 +02:00
parent 9b6de9c411
commit 5d967f5b7b
9 changed files with 171 additions and 141 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/obilittlebigman.h
View File

@ -11,17 +11,17 @@
#include <stdbool.h>
/**
* Test is the architecture of the processor is little endian.
* Test if the architecture of the processor is little endian.
*
* ##Two classes of CPU architecture can be define:
* ##Two classes of CPU architecture can be defined:
* - little endian
* - big endian
*
* They describe the way the processor store multi-byte values
* in memory. Considering an 32 bits integer value encoded in
* hexadecimal `0x11223344`. This value needs four bytes to be
* stored. These for bytes will have consecutive addresses in memory.
* Let says that these addresses will be : 01, 02, 03, and 04
* They describe the way the processor stores multi-byte values
* in memory. If we consider a 32 bits integer value encoded in
* hexadecimal `0x11223344`, this value needs four bytes to be
* stored. These four bytes will have consecutive addresses in memory.
* Let's say that these addresses will be : 01, 02, 03, and 04
*
* ###A big endian architecture will store our integer with the following schema:
*
@ -29,7 +29,7 @@
* ---------|------|------|------|------
* value | Ox11 | Ox22 | 0x33 | 0x44
*
* In this architecture the last address (the end of the representation) is
* In this architecture, the last address (the end of the representation) is
* used to store the byte of higher weight (BIG ENDian)
*
* ###A little endian architecture will store our integer with the following schema:
@ -38,7 +38,7 @@
* ---------|------|------|------|------
* value | Ox44 | Ox33 | 0x22 | 0x11
*
* In this architecture the last address is
* In this architecture, the last address is
* used to store the byte of lighter weight (LITTLE ENDian)
*
* @return a `bool` value:
@ -48,7 +48,7 @@
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
bool obi_is_little_end();
bool obi_is_little_endian();
#endif /* OBILITTLEBIGMAN_H_ */