https://bugs.freedesktop.org/show_bug.cgi?id=44502
Bug #: 44502 Summary: Improve Doxygen-generated SDK C++ documentation Classification: Unclassified Product: LibreOffice Version: LibO Master Platform: Other OS/Version: All Status: NEW Severity: normal Priority: medium Component: Libreoffice AssignedTo: libreoffice-bugs@lists.freedesktop.org ReportedBy: sberg...@redhat.com The LibreOffice UNO SDK contains HTML documentation for the C/C++ entities that make up the interface of the UNO runtime environment (reached from the sdk/index.html starting page via the "C++ Reference" link). This documentation is now extracted from the relevant headers (modules sal, salhelper, cppu, cppuhelper, store, registry) with Doxygen. In the past, it used to be extracted with LO's own tool autodoc, which however had serious shortcomings. Most of the documentation syntax is the same for Doxygen and autodoc, but there are some differences, and Doxygen additionally warns for some things that autodoc silently ignored, like a misspelled "@param foo" that does not match any actual parameter name. Running doxygen at odk/pack/gendocu thus produces a large number of warnings. Some of them have been cleaned up with the initial commit <http://cgit.freedesktop.org/libreoffice/core/commit/?id=58ab12acf576a765ec47cc2753ba57643e51d653>, but lots still need to be addressed. Additionally, the documentation could need some general clean up, anyway (e.g., consistency in using full stops or not at end of documentation phrases, add missing documentation, use proper markup). Third, the "branding" of the generated HTML uses the default Doxygen settings and thus looks rather different from what the old, autodoc-generated HTML (still there at <http://api.libreoffice.org/docs/cpp/ref/index.html> as of today). The odk/pack/gendocu/Doxyfile could probably benefit from some more tweaking. (It is of course OK to only work on some part of this rather broad issue.) -- Configure bugmail: https://bugs.freedesktop.org/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are the assignee for the bug. _______________________________________________ Libreoffice-bugs mailing list Libreoffice-bugs@lists.freedesktop.org http://lists.freedesktop.org/mailman/listinfo/libreoffice-bugs