Browse Source

* more doxygen comments

master
Alex 'AdUser' Z 8 years ago
parent
commit
dc93c00cde
  1. 8
      src/bitmap.c
  2. 2
      src/bitmap.h
  3. 8
      src/database.c

8
src/bitmap.c

@ -14,10 +14,16 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor Boston, MA 02110-1301, USA * Foundation, Inc., 51 Franklin Street, Fifth Floor Boston, MA 02110-1301, USA
*/ */
/**
* @file
* @brief Functions for work with image bitmaps
*/
#include "common.h" #include "common.h"
#include "bitmap.h" #include "bitmap.h"
unsigned char dict[256] = { /** bictionary for speedup bitmap comparing */
static unsigned char dict[256] = {
/* 0x00 _0 _1 _2 _3 _4 _5 _6 _7 _8 _9 _A _B _C _D _E _F */ /* 0x00 _0 _1 _2 _3 _4 _5 _6 _7 _8 _9 _A _B _C _D _E _F */
/* ---------------------------------------------------- */ /* ---------------------------------------------------- */
/* 0_ */ 0, 1, 1, 2, 1, 2, 2, 3, 1, 2, 2, 3, 2, 3, 3, 4, /* 0_ */ 0, 1, 1, 2, 1, 2, 2, 3, 1, 2, 2, 3, 2, 3, 3, 4,

2
src/bitmap.h

@ -53,7 +53,7 @@ simdb_bitmap_unpack(const unsigned char *map,
/** /**
* @brief Print bitmap to stdout as ascii-square * @brief Print bitmap to stdout as ascii-square
* @param map Source bitmap * @param map Source bitmap
* @note Heigth of "square" is equals to BITMAP_SIDE, * @note Height of "square" is equals to BITMAP_SIDE,
* but width is BITMAP_SIDE x 2, for ease of reading * but width is BITMAP_SIDE x 2, for ease of reading
*/ */
void void

8
src/database.c

@ -14,6 +14,11 @@
* Foundation, Inc., 51 Franklin Street, Fifth Floor Boston, MA 02110-1301, USA * Foundation, Inc., 51 Franklin Street, Fifth Floor Boston, MA 02110-1301, USA
*/ */
/**
* @file
* Common routines to work with database
*/
#include "common.h" #include "common.h"
#include "bitmap.h" #include "bitmap.h"
#include "simdb.h" #include "simdb.h"
@ -24,17 +29,20 @@ struct _simdb_t {
char path[PATH_MAX]; /**< path to database file */ char path[PATH_MAX]; /**< path to database file */
}; };
/** read some records from database file and checks for errors */
#define DB_READ(db, buf, len, off) \ #define DB_READ(db, buf, len, off) \
errno = 0; \ errno = 0; \
memset((buf), 0x0, (len)); \ memset((buf), 0x0, (len)); \
bytes = pread((db)->fd, (buf), (len), (off)); \ bytes = pread((db)->fd, (buf), (len), (off)); \
if (errno) { return SIMDB_ERR_SYSTEM; } if (errno) { return SIMDB_ERR_SYSTEM; }
/** write some records from database file and checks for errors */
#define DB_WRITE(db, buf, len, off) \ #define DB_WRITE(db, buf, len, off) \
errno = 0; \ errno = 0; \
bytes = pwrite((db)->fd, (buf), (len), (off)); \ bytes = pwrite((db)->fd, (buf), (len), (off)); \
if (errno) { return SIMDB_ERR_SYSTEM; } if (errno) { return SIMDB_ERR_SYSTEM; }
/** database header format line */
const char *simdb_hdr_fmt = "IMDB v%02u, CAPS: %s;"; const char *simdb_hdr_fmt = "IMDB v%02u, CAPS: %s;";
bool bool

Loading…
Cancel
Save