[vtk-developers] Strange problem with doxygen script

[David Doria]

On Wed, Dec 16, 2009 at 12:18 PM, David Doria <daviddoria+vtk at gmail.com> wrote:
> On Wed, Dec 16, 2009 at 12:14 PM, Marcus D. Hanwell
> <marcus.hanwell at kitware.com> wrote:
>> On Monday 14 December 2009 21:16:39 David Doria wrote:
>>> On Fri, Dec 11, 2009 at 6:52 PM, Marcus D. Hanwell
>>> >
>>> > I will see what the response from the author is. If anyone has any
>>> > further ideas please let me know. It would be good to document how the
>>> > scripts are supposed to work. If there any plan to ever just run the
>>> > header converter on the headers one day and do a very big commit so that
>>> > this Perl step is not necessary?
>>> >
>>> > Marcus
>>>
>>> Marcus,
>>>
>>> I don't know if you were auto-notified of this, but someone responded
>>> that the bug was previously reported:
>>> https://bugzilla.gnome.org/show_bug.cgi?id=593040
>>>
>>> It's discouraging that it is 4 months old! :(
>>>
>> Don't be discouraged - I did what any open source developer would do in this
>> situation...I used the *SOURCE* ;-) I have emailed Dimitri (the Doxygen
>> author), and he seems receptive to fixing this. I have a preliminary patch I
>> came up with on Saturday, once I find a spare hour I will clean up the patch,
>> do a little more testing and attach the patch to the bug.
>>
>> I am hopeful that this will be integrated into the next Doxygen release, and
>> in the meantime we can use a locally patched Doxygen to generate our docs. I
>> think this is preferable to changing thousands of lines of comments (may be
>> tens of thousands), as this does in fact seem to be a Doxygen bug.
>>
>> I am really busy work on 2D in VTK, getting the new chart classes to work in
>> ParaView and adding extra functionality. I hope to get to finishing the patch
>> in the next day or two though.
>>
>> I am also hoping to add some improved documentation to some of my new classes
>> now that the API is settling down. Unfortunately I will have to change the API
>> for some classes, and this will require updates to the examples you wrote.
>>
>> Marcus
>> --
>> Marcus D. Hanwell, Ph.D.
>> R&D Engineer, Kitware Inc.
>> (518) 881-4937
>>
>
> Excellent! Glad to hear it. I think this will really be a huge improvement.
>
> No problem if the examples break temporarily - once we get them
> cleaned up and moved into the CVS we'll be alerted when they no longer
> match the new interface. At that point we can fix them.
>
> Thanks,
>
> David
>

Just to share the resolution - Marcus worked with the Doxygen
developers to resolve this bug. The VTK docs look much better now :)

Thanks Marcus!

David D.