libnbtplusplus icon indicating copy to clipboard operation
libnbtplusplus copied to clipboard

Requires documentation

Open Jamesthe1 opened this issue 5 years ago • 1 comments

While this is a resourceful tool, I can’t find anything that lets me know how to use it. I’m not sure how to write or read NBT files either.

Jamesthe1 avatar May 13 '19 12:05 Jamesthe1

@Jamesthe1 Library is enough documented. Check header files for descriptions. Additionaly after you make project you can read headers of test cases to see how library is used. You can use Doxygen to generate documentation as static web page. . In workspace directory generate confing by doing doxygen -g Doxyfile, then edit that config file, find option RECURSIVE and set it to RECURSIVE = YES. Then run doxygen once more without parameters, it will generate static web page. Open file ./html/index.htm in browser... Class list from it helped me a lot...

MajsterTynek avatar May 20 '20 21:05 MajsterTynek