Documentation requeset
#92
Comments
|
@lonble : Yes, I do have plans to update the current documentation. Thanks for reminding me and I'll push the patch in a few weeks. Before releasing the new documentation, you can check the examples. If you want to see some common examples, please also let me know, since I also plan to expand the sample applications. |
|
There is a docs directory that has numerous references to doxygen generated documentation, but there is no link to a web site with that documentation? Is this intentional? Should we just generate our own with doxygen rather than relying on you doing so when you make a release? |
|
Hi @alanmimms , thanks for reminding me this issue. My original plan is using the Sphinx-based toolchain to generate the documentation from the Doxygen comments in the code base, and then copy the generated documentation to argtable.org, so that the website can always be up-to-date. However, I haven't finish this plan yet. I plan to make a release in June. If I cannot finish the documentation at that time, I'll temporarily remove the |
Do you have plans to provide complete documentation? The content in https://www.argtable.org/tutorial/ seems out of date, and a large number of APIs lack descriptions.
I had to read the source code to understand what advanced features this library provides, but it's over six thousand lines of code, which is a little frustrating.
The text was updated successfully, but these errors were encountered: