mirror of https://github.com/libAthena/athena.git
44 lines
1.2 KiB
C++
44 lines
1.2 KiB
C++
|
#ifndef __MAINPAGE_HPP__
|
||
|
|
#define __MAINPAGE_HPP__
|
||
|
|
|
||
|
|
/*! \mainpage libZelda
|
||
|
|
* \section intro_sec Introduction to libZelda
|
||
|
|
* libZelda is an IO Library which is designed to be powerful, simple,
|
||
|
|
* and infinitely extensible. <br />
|
||
|
|
* <br />
|
||
|
|
* libZelda provides several basic classes that can be used to read from
|
||
|
|
* and write to files, and memory, classes such as Stream, BinaryReader, BinaryWriter,
|
||
|
|
* and the currently work in progress TextStream.
|
||
|
|
* \section example_sec BinaryWriter example
|
||
|
|
* \code
|
||
|
|
* #include "BinaryWriter.hpp"
|
||
|
|
* #include "FileNotFoundException.hpp"
|
||
|
|
* #include "Exception.hpp"
|
||
|
|
* int main()
|
||
|
|
* {
|
||
|
|
* try
|
||
|
|
* {
|
||
|
|
* BinaryWriter writer("test.bin");
|
||
|
|
* writer.writeByte('t');
|
||
|
|
* writer.writeInt32(123454321);
|
||
|
|
* writer.save();
|
||
|
|
* }
|
||
|
|
* catch (FileNotFoundException e)
|
||
|
|
* {
|
||
|
|
* std::cout << e.message() << std::endl;
|
||
|
|
* }
|
||
|
|
* catch (Exception e)
|
||
|
|
* {
|
||
|
|
* std::cout << e.message() << std::endl;
|
||
|
|
* }
|
||
|
|
* catch(...)
|
||
|
|
* {
|
||
|
|
* }
|
||
|
|
* return 0;
|
||
|
|
* }
|
||
|
|
* \endcode
|
||
|
|
* \section Credits
|
||
|
|
* Chibi Zelda: AnimeWaterFall on Deviantart
|
||
|
|
*/
|
||
|
|
#endif // __MAINPAGE_HPP__
|