libvncserver icon indicating copy to clipboard operation
libvncserver copied to clipboard

Improve API doc visuals

Open bk138 opened this issue 5 years ago • 2 comments

  • using sphinx and breathe:
    • https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/
  • standalone doxygen
    • https://mcss.mosra.cz/documentation/doxygen/
    • https://stackoverflow.com/questions/36064976/using-doxygen-in-read-the-docs

bk138 avatar Apr 27 '20 22:04 bk138

Hi I can work on this , doxygen will be very perfect

Quadrisheriff avatar May 17 '20 11:05 Quadrisheriff

@Quadrisheriff Very welcome!

We already use doxygen, but it's customisation possibilities are quite limited. I reckon that the approach using sphinx and breathe will yield the best visual results.

bk138 avatar May 17 '20 12:05 bk138