Documentation

Documentation with Doxygen

The library's documentation is generated using Doxygen. You'll need Doxygen installed in order to build the documentation.

On Linux, you can generate the documentation using make by specifying the doc target.

cd build
cmake .. -DCMAKE_BUILD_TYPE=Release
make doc

On Windows with Visual Studio, follow the instructions in the Building section above. For the final step, right-click on doc instead of ALL_BUILD and then select Build.

The documentation will be created as an HTML website in your build directory under doc/html. Open the file doc/html/index.html to begin browsing the documentation.

Documentation without Doxygen

You can also directly browse the underlying sources used to generate the Doxygen documentation.

• doc/index.md is the introductory page.
• library/public/eaarlio contains the header files for the library. Each header file is thoroughly documented to provide the information that goes into the Doxygen documentation.
• doc/examples.dox provides a short description for files that serve as good examples to help learn the library. The example files referenced can be found elsewhere in the repository.
• doc/testing.md provides instructions on how to run the test suite.
• doc/tld_format.md and doc/edb_format.md document the underlying file formats for TLD and EDB files.
• doc/developer.md provides some information directed towards individuals who wish to contribute to the library.