libAthena
/
athena
mirror of https://github.com/libAthena/athena.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Added DNA.hpp warning

This commit is contained in:
Jack Andersen 2015-06-16 16:50:12 -10:00
parent 791a355ace
commit 2c63768ec4
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
include/Athena/DNA.hpp
View File

@ -1,11 +1,16 @@
#ifndef DNA_HPP #ifndef DNA_HPP
#define DNA_HPP #define DNA_HPP
/* BIG FAT WARNING!!!
*
* The type-structure of this file is expected to remain consistent for 'atdna'
* Any changes to the types or namespacing must be reflected in 'atdna/main.cpp'
*/
#include "Global.hpp" #include "Global.hpp"
#include "IStreamReader.hpp" #include "IStreamReader.hpp"
#include "IStreamWriter.hpp" #include "IStreamWriter.hpp"
#include <vector> #include <vector>
#include <functional>
namespace Athena namespace Athena
{ {
@ -16,7 +21,9 @@ namespace io
* @brief Base DNA class used against 'atdna' * @brief Base DNA class used against 'atdna'
* *
* Athena bundles a build-tool called 'atdna'. This tool functions * Athena bundles a build-tool called 'atdna'. This tool functions
* just like the 'clang' compiler, except it emits * just like the 'clang' compiler, except it emits a full .cpp implementation
* with all read/write calls necessary to marshal the DNA structure to/from
* a streamed medium
*/ */
template <Endian DNAE> template <Endian DNAE>
struct DNA struct DNA