Ignore:
Timestamp:
Feb 29, 2012, 10:01:25 PM (7 years ago)
Author:
ksherdy
Message:

Updated comments format.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/lib/byte_compare.hpp

    r1852 r1950  
    1 /*
     1#ifndef BYTE_COMPARE_HPP
     2#define BYTE_COMPARE_HPP
     3
     4/*=============================================================================
    25    byte_compare - Byte comparison methods.
    36
     
    69    Licensed to the public under the Open Software License 3.0.
    710    Licensed to International Characters Inc.
    8        under the Academic Free License version 3.0.
     11    under the Academic Free License version 3.0.
     12=============================================================================*/
    913
    10 
    11    WARNING:
    12        
    13    for L is 1, choose T = uint8_t
    14    for L in [2,3], choose T = uint16_t
    15    for L in [4,7], choose T = uint32_t
    16    for L in [8,15], choose = uint64_t
    17    for L in [16,00), T = BitBlock
    18 
    19    Otherwise results are not valid due to pointer casts.
    20 
    21    TODO - STATIC ASSERT - sizeof(T) <= L
    22 
    23 */
    24 
    25 #ifndef BYTE_COMPARE_HPP
    26 #define BYTE_COMPARE_HPP
     14///////////////////////////////////////////////////////////////////////////////
     15//
     16//   WARNING: L (Length)
     17//
     18//   for L is 1, choose T = uint8_t
     19//   for L in [2,3], choose T = uint16_t
     20//   for L in [4,7], choose T = uint32_t
     21//   for L in [8,15], choose = uint64_t
     22//   for L in [16,00), T = BitBlock
     23//   Otherwise results are not valid due to pointer casts.
     24//
     25//   TODO - STATIC ASSERT - sizeof(T) <= L
     26//
     27///////////////////////////////////////////////////////////////////////////////
    2728
    2829#include "bitblock.hpp"
Note: See TracChangeset for help on using the changeset viewer.