Figure out how to generate slice documentation in the future
Opened this issue · 0 comments
Our generated slice documentation has always been a very simple html file structure.
Ice 3.6 still contains the slice2html executable. Ice 3.7 does not and tells you to use doxygen, which supports slice.
See v3.6-Usingslice2html and v3.7 Using Doxygen for Slice Documentation.
The doxygen generated HTML documentation is a lot more complex and IMHO overkill, and reduces readability and discoverability instead of improving it.
We should explore and decide on how we want to handle this in the future. Possibly establish a (documented or automated) generation workflow.
Ice has moved from slice file and dynamic type usage to generated code for more languages (namely PHP as well). Arguably, the generated types are enough with a decent IDE. Although being able to link to types and read them without generated code available would be very useful at times.
This issue became apparent in #60.