Skip to content
This repository has been archived by the owner on Jun 15, 2024. It is now read-only.

Requires documentation #13

Open
Jamesthe1 opened this issue May 13, 2019 · 1 comment
Open

Requires documentation #13

Jamesthe1 opened this issue May 13, 2019 · 1 comment

Comments

@Jamesthe1
Copy link

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.

@MajsterTynek
Copy link

MajsterTynek commented May 20, 2020

@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...

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants
@MajsterTynek @Jamesthe1 and others