search

tfussell / xlnt

:bar_chart: Cross-platform user-friendly xlsx library for C++11+
Other
1.47k stars 409 forks source link

Is there more documentation? #610

Closed algaspar closed 2 years ago

algaspar commented 2 years ago

Hi,

This is not an actual issue with the code, but it is an issue with the documentation.  I have downloaded the library and used it to compile the examples in Visual Studio.  I can't find any basic information on how to do multiple sheets or even an explanation of the functions in the examples.  For example, xlnt::workbook and xlnt::worksheet work in the examples, but I don't see any explanation of how they work, what can be passed to them, etc. in the documentation.  Is there some other documentation that I'm missing?  Thanks for any help.

Best--

Al

tfussell commented 2 years ago

I would like to write more extensive documentation, but it has always been lower priority than bug fixes unfortunately. The best docs are at https://tfussell.gitbooks.io/xlnt/content/. xlnt::workbook and xlnt::worksheet are analogous to a workbook and a worksheet in Excel. All I can recommend for now is to look at examples, the test suite, and the headers to see how objects can be used. The library was originally inspired by the Python library openpyxl so you might also take a look here for an introduction in a different language.