diff --git a/README.md b/README.md index 79f49ef..44d77cd 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ # mcSavefileParsers -Multiple programs for Minecraft [save file data extraction](#data-extraction-utilities) and [3D model generation](#3d-model-generation) based on save files. +[![GitHub Pages Documentation](https://img.shields.io/badge/GitHub_Pages-Documentation-blue)](https://tca166.github.io/mcSavefileParsers/) + +Multiple programs for Minecraft [save file data extraction](#data-extraction-utilities) and [3D model generation](#3d-model-generation) based on save files. +Also several well documented custom C libraries with minimal prerequisites for wavefront 3d model handling and Minecraft save file handling. ## Getting started @@ -142,7 +145,7 @@ These are compiled automatically using make, and then linked together into cNBT. Most of the code has been organized into four "libraries". These may prove to be useful should you want to parse Minecraft save files or generate wavefront 3D models. Feel free to use these as libraries in your projects just make sure to read the license before you do so. -The documentation for functions in these libraries should be mainly in header files, and I will gladly expand it should there be a need so just let me know. +The documentation for functions in these libraries should be mainly in header files and on [GitHub Pages](https://tca166.github.io/mcSavefileParsers/), and I will gladly expand it should there be a need so just let me know. - regionParser This library provides three functions for parsing region files. diff --git a/doc/Doxyfile.conf b/doc/Doxyfile.conf index 47e5612..aa6b636 100644 --- a/doc/Doxyfile.conf +++ b/doc/Doxyfile.conf @@ -864,7 +864,7 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ./src +INPUT = ./src ./README.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 @@ -1061,7 +1061,7 @@ FILTER_SOURCE_PATTERNS = # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. -USE_MDFILE_AS_MAINPAGE = +USE_MDFILE_AS_MAINPAGE = ./README.md #--------------------------------------------------------------------------- # Configuration options related to source browsing @@ -2272,7 +2272,7 @@ INCLUDED_BY_GRAPH = YES # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -CALL_GRAPH = NO +CALL_GRAPH = YES # If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller # dependency graph for every global function or class method. @@ -2284,7 +2284,7 @@ CALL_GRAPH = NO # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. -CALLER_GRAPH = NO +CALLER_GRAPH = YES # If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical # hierarchy of all classes instead of a textual one. diff --git a/src/lib/chunkParser.h b/src/lib/chunkParser.h index 88c7e93..d40bc25 100644 --- a/src/lib/chunkParser.h +++ b/src/lib/chunkParser.h @@ -6,7 +6,6 @@ /*! @defgroup chunkParser Chunk Parser - @ingroup chunkParser @brief Chunk data parsing functions */ @@ -47,8 +46,18 @@ typedef struct block{ */ #define maxSections 24 +/*! + @def mcAir + @brief The minecraft air block identifier + @ingroup chunkParser +*/ #define mcAir "minecraft:air" -#define minY -64 +/*! + @def minY + @brief The minimum y coordinate + @ingroup chunkParser +*/ +#define minY -maxSections*4 /*! @brief Extracts sections from raw nbtFileData of size into sections array diff --git a/src/lib/model.h b/src/lib/model.h index f3c789e..9f63b4f 100644 --- a/src/lib/model.h +++ b/src/lib/model.h @@ -137,7 +137,7 @@ typedef struct model{ for(int z = 0; z < zLim; z++) /*! - @def foreachVertex + @def foreachObject @brief Foreach object in a model*. Provides index variable o, and assures that the object will not be null @param model The model to iterate over @ingroup model