diff options
| author | Pieter Wuille <pieter.wuille@gmail.com> | 2012-03-26 16:48:23 +0200 |
|---|---|---|
| committer | Pieter Wuille <pieter.wuille@gmail.com> | 2012-03-26 16:48:23 +0200 |
| commit | 6b8de05d0a6696dff4b7dccec5b74889f3cdc486 (patch) | |
| tree | 123b892a842e3a99342cc4806b4a833b2a635b52 /src/serialize.h | |
| parent | 01a196e08db49d83cf6c5abd8a799c56dcfef503 (diff) | |
Begin doxygen-compatible comments
Diffstat (limited to 'src/serialize.h')
| -rw-r--r-- | src/serialize.h | 34 |
1 files changed, 16 insertions, 18 deletions
diff --git a/src/serialize.h b/src/serialize.h index c046bf37ef..25777fe3c5 100644 --- a/src/serialize.h +++ b/src/serialize.h @@ -265,11 +265,11 @@ uint64 ReadCompactSize(Stream& is) -// -// Wrapper for serializing arrays and POD -// There's a clever template way to make arrays serialize normally, but MSVC6 doesn't support it -// #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj))) + +/** Wrapper for serializing arrays and POD. + * There's a clever template way to make arrays serialize normally, but MSVC6 doesn't support it. + */ class CFlatData { protected: @@ -302,9 +302,7 @@ public: -// -// string stored as a fixed length field -// +/** string stored as a fixed length field */ template<std::size_t LEN> class CFixedFieldString { @@ -856,11 +854,11 @@ struct zero_after_free_allocator : public std::allocator<T> -// -// Double ended buffer combining vector and stream-like interfaces. -// >> and << read and write unformatted data using the above serialization templates. -// Fills with data in linear time; some stringstream implementations take N^2 time. -// +/** Double ended buffer combining vector and stream-like interfaces. + * + * >> and << read and write unformatted data using the above serialization templates. + * Fills with data in linear time; some stringstream implementations take N^2 time. + */ class CDataStream { protected: @@ -1220,12 +1218,12 @@ int main(int argc, char *argv[]) -// -// Automatic closing wrapper for FILE* -// - Will automatically close the file when it goes out of scope if not null. -// - If you're returning the file pointer, return file.release(). -// - If you need to close the file early, use file.fclose() instead of fclose(file). -// +/** RAII wrapper for FILE*. + * + * Will automatically close the file when it goes out of scope if not null. + * If you're returning the file pointer, return file.release(). + * If you need to close the file early, use file.fclose() instead of fclose(file). + */ class CAutoFile { protected: |