Re: [Doxygen-users] installdox

[Alexander R. <ale...@as...>]

Hi Dimitry,

thank you for the information.

Am 13.02.2012 20:24, schrieb Dimitri Van Heesch:
> Hi Alexander,
>
> On Feb 13, 2012, at 14:37 , Alexander Rettig wrote:
>
>> Hello Dimitri,
>>
>> first of all, thanks for developing Doxygen for years, it is a great
>> tool which I would miss really sadly if it was not there.
>>
>> I just recently found the tool 'installdox' very useful for 'publishing'
>> generated documentation with external references (3 projects referencing
>> each other like A is known by B, C knows A and B).
>> Updating the links seemed to work quite good except for the navtree part
>> (but there may be other places where it fails).
>> Now I've seen, that you skipped installdox completely in a recent
>> release because you found the tool not working properly.
>
> Correct, I have removed doxytag and installdox.
>
>>
>> So my questions:
>>
>> Now, is the only way of getting external links right to (re)generate the
>> doc completely with doxygen using appropriate TAGFILES settings or is
>> there another recommended way?
>
> No, using TAGFILES is the recommended way.
>
>>
>> Do you think there is a chance to fix the problems with the installdox
>> script or are there to many issues? I only found problems with updating
>> the navtree.js (Doxygen 1.7.5.x. If I'm right, at this point things
>> changed also a little in 1.7.6...), which I could fix by slightly
>> modifying navtree.js and the generated installdox script (I wanted to
>> offer the fix but then I saw, that installdox was gone). Which links
>> were not correctly updated by the script, do you have information about
>> that? Because, if you don't think the installdox concept is
>> systematically broken and there are not too many situations where it
>> failed, I probably could fix it and provide it to you then (maybe this
>> belongs to the develop mailing list though ;-)).
>
> I think the installdox and doxytag tools were inherently too fragile.
> Parsing the output is just not a really good thing to do. Using doxygen="..."
> as an attribute name in the HTML output was not valid HTML either.
>
> Doxytag and installdox were already broken a long time and nobody really
> complained much, so I decided to drop support for it, rather than to
> keep spending time to temporarily fix the problem.
>
> Using TAGFILES has the drawback that it is less flexible to move output
> around at a later point in time. But if you use relative paths, it should
> not be such a big deal, as you can still move the documentation sets
> together to a new location without breaking any link.

As relative paths don't do it in my case (one project is external and I 
don't want to keep its subdirectory layout when publishing which would 
be necessary to have stable relative paths), I will just regenerate the 
documentation for publishing.

On thought: isn't doxygen generating intermediate data structures/files 
which probably could be kept and reused? So the time consuming part of 
parsing the input and setting up the link structure could be avoided if 
only some links have to be adjusted in the output.

But on the other hand - generating *and publishing* documentation is 
nothing which has to be done in a fast cycle, so speeding this up is not 
really worth the effort.

Thanks again,
Alex

>
> Regards,
>    Dimitri
>