[Doxygen-develop] [PATCH] UNO IDL bugfixes and PREDICTABLE_URLS option
Brought to you by:
dimitri
From: Michael S. <ms...@re...> - 2013-05-03 15:08:12
|
hello Dimitri, thanks for merging UNO IDL patches :) i've had some more time to spend on doxygen this week, and results are looking quite good now (in LibreOffice feature/doxygen branch). 1. there were still a few bugs, fixed by the attached patch 2. one problem i've had is that we have not only the generated per-entity reference documentation but also another form of documentation in the form of a large number of Wiki pages, with links in both directions. the legacy "autodoc" tool has native support for reading a special file that essentially contains links into the Wiki that need to be inserted into the generated per-entity reference documentation. i've played around a bit and found that i could generate an extra dummy input file that contains empty definitions, and put the Wiki links on them as doxygen comments, and feed that as the last input file (to prevent spurious references to generated file) and doxygen will combine the docs nicely. http://cgit.freedesktop.org/libreoffice/core/commit/?h=feature/doxygen&id=b3dbf93c5e18b6f31b11f9bcc08a105b2e0d3b10 3. for the other direction there are some issues... the Wiki documentation links to the per-entity reference documentation with some convenient template like; <idl>com.sun.star.ucb.XContentIdentifierFactory</idl> to get this to work the target URLs need to be generated automatically just from the namespace qualified entity name. this required some changes to doxygen, adding a new PREDICTABLE_URLS config option, see attached patch. 4. we are currently just a couple weeks away from the LO 4.1 feature freeze, and i'd like to merge this into the 4.1 release.... which distributions will package... so we would need a release of doxygen with all the UNO IDL patches that distros can package as build-dep. i'll follow up in a separate mail on this. regards, michael |