From b8b1d32af61982a6f500a810f7a00772a7102433 Mon Sep 17 00:00:00 2001 From: Mateo FERON Date: Thu, 20 Feb 2020 11:37:11 +0100 Subject: [PATCH] Add separate md info --- Doxyfile | 2 +- include/filedat.hpp | 7 ++++--- filedat.md => md/filedat.md | 10 +++++----- md/ztd.md | 8 ++++++++ 4 files changed, 18 insertions(+), 9 deletions(-) rename filedat.md => md/filedat.md (94%) create mode 100644 md/ztd.md diff --git a/Doxyfile b/Doxyfile index cfc7e52..30b7dd4 100644 --- a/Doxyfile +++ b/Doxyfile @@ -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 diff --git a/include/filedat.hpp b/include/filedat.hpp index 1fef2b9..f03bc44 100644 --- a/include/filedat.hpp +++ b/include/filedat.hpp @@ -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); } diff --git a/filedat.md b/md/filedat.md similarity index 94% rename from filedat.md rename to md/filedat.md index b40a25f..3c23ac5 100644 --- a/filedat.md +++ b/md/filedat.md @@ -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 diff --git a/md/ztd.md b/md/ztd.md new file mode 100644 index 0000000..5610e93 --- /dev/null +++ b/md/ztd.md @@ -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) +