Add separate md info

This commit is contained in:
Mateo FERON 2020-02-20 11:37:11 +01:00
parent fa40e30a13
commit b8b1d32af6
4 changed files with 18 additions and 9 deletions

View file

@ -813,7 +813,7 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = include
INPUT = include md
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

View file

@ -14,7 +14,8 @@
/*! @file filedat.hpp
* @brief Storing and reading data
*
* Easily organize data in a JSON-like file format
* Easily organize data in a JSON-like file format.
* See [ZFD format](@ref zfd)
*/
namespace ztd
@ -130,14 +131,14 @@ namespace ztd
@param in C string data
@param in_size Size of the string data
@param offset Used for debugging
@param data Used for debugging
@param parent Used for debugging
*/
void set(const char* in, const int in_size, int offset=0, filedat* parent=nullptr);
//! @brief Set data
/*!
@param in String data
@param offset Used for debugging
@param data Used for debuggingy
@param data Used for debugging
*/
inline void set(std::string const& in, int offset=0, filedat* data=nullptr) { this->set(in.c_str(), in.size(), offset, data); }

View file

@ -1,9 +1,9 @@
# ZFD format details
# ZFD format {#zfd}
The format is composed of infinitely concatenable "chunks". There a three types of chunks:
-Map chunk : between braces {}
-List chunk : between brackets []
-String value
ZFD is composed of infinitely concatenable "chunks". There a three types of chunks:
- Map chunk : between braces {}
- List chunk : between brackets []
- String value
Formatting is ignored, all spaces will be ignored unless they are part of a value.
Comments can be written with //, ends at end of line

8
md/ztd.md Normal file
View file

@ -0,0 +1,8 @@
# ztd {#mainpage}
zawz's standard C++ library. Tools for easier coding
Github: http://github.com/zawwz/ztd
[ZFD format details](@ref zfd)