Changeset 62 in pacpusframework for trunk/include/Pacpus/PacpusTools/BinaryDecoder.h

Timestamp:

01/09/13 17:26:04 (11 years ago)

Author:

Marek Kurdej

Message:

Update: license info.

File:

• trunk/include/Pacpus/PacpusTools/BinaryDecoder.h (modified) (1 diff)

trunk/include/Pacpus/PacpusTools/BinaryDecoder.h

@@ -1 @@
-/*********************************************************************
-//  created:    2008/07/22 - 16:57
-//  filename:   BinaryDecoder.h
-//
-//  author:     Gerald Dherbomez
-//              Copyright Heudiasyc UMR UTC/CNRS 6599
-//
-//  version:    $Id: $
-//
-//  purpose:    Extract data of specified type in a string (char *)
-//              Usage:
-//              bool xDecodeToXXX(T* result, const char * data, const unsigned int startBit, const unsigned int length)
-//                => x = format (i:Intel, Little Endian)
-//                              (m:Motorola, Big Endian)
-//                => XXX = type of return value
-//                         (Bool = bool)
-//                         (I8 = char - 8 bits)
-//                         (UI8 = unsigned char - 8 bits)
-//                         (I16 = short - 16 bits)
-//                         (UI16 = unsigned short - 16 bits)
-//                         (I32 = long - 32 bits)
-//                         (UI32 = unsigned long - 32 bits)
-//                         (I64 = long long - 64 bits)
-//                         (UI16 = unisgned long long - 64 bits)
-//
-//              ex: inline bool mDecodeToUI16(r, str, 8, 12);
-//
-*********************************************************************/
+// This file is part of the PACPUS framework distributed under the
+// CECILL-C License, Version 1.0.
+// 
+/// @author  Gerald Dherbomez <firstname.surname@utc.fr>
+/// @date    July, 2008
+/// @version $Id$
+/// @copyright Copyright (c) UTC/CNRS Heudiasyc 2006 - 2013. All rights reserved.
+/// @brief Extracts data of specified type in a string.
+///
+/// Purpose:    Extract data of specified type in a string (char *)
+/// Usage:
+///     bool xDecodeToXXX(T* result, const char * data, const unsigned int startBit, const unsigned int length)
+///     => x = format (i:Intel, Little Endian)
+///                   (m:Motorola, Big Endian)
+///     => XXX = type of return value
+///                   (Bool = bool)
+///                   (I8 = char - 8 bits)
+///                   (UI8 = unsigned char - 8 bits)
+///                   (I16 = short - 16 bits)
+///                   (UI16 = unsigned short - 16 bits)
+///                   (I32 = long - 32 bits)
+///                   (UI32 = unsigned long - 32 bits)
+///                   (I64 = long long - 64 bits)
+///                   (UI16 = unisgned long long - 64 bits)
+///
+///     ex: inline bool mDecodeToUI16(r, str, 8, 12);
 
 #ifndef BINARYDECODER_H