OpenCV 3 doxygen documentation still very counter intuitive
I would like to open up this topic to bundle together all possible suggestions that could improve the current doxygen documentation. I understand why the change has been made, but for now I find it myself quite hard to find any usefull information on it. The interface is far from intuitive like before.
Got any suggestions? Let me know!
Small wrapup of suggestions
- Table of content on the left hand side
- Using the complete available page size whenever possible
- Better way to find documentation like tutorials
- Search functionality is still improvable even tough it was worse on the old documentation
- Samples listed are far from all the samples available
- More similar css like style as previous interface
I feel the same! Why did they change it?
I am new using opencv but to learn I look in opencv 2 doc and after in opencv 3 doc. May be it could be possible to improve to have something like this with table of content
I agree with you. For me, the table of contents on the left panel is missing, and it is too bad that not all the space is used.
I also feel the same! But maybe after some time, we will enjoy it? It is still missing (at least) the table of content, and an easy access to the tutorials. Doxygen has a lot of configuration options, but it could take some time to customize it the right way. Maybe, also using more "similar" css could help in the transition...
@Mathieu Barnachon of course a transition time is needed, but combining our efforts together can help the admins to get it more in the line of what the user community is expecting.
May be in function description add sample name using this function.
Steven, you say you understand why they changed it. I do not. In fact, a little earlier today, I asked this question looking for some insight as to why they changed it. My experience has been doxygen is great for API reference documentation. But it is not as good at the often more important documentation like tutorials and user manuals. OpenCV 2 with its sphinx documentation had already gone to the trouble of using sphinx, so I was surprised (and disappointed) to see they abandoned it for doxygen. I think using doxylink and/or breathe to combine doxygen with sphinx would have been better.
I'm also missing pdf documentation for new OpenCV.