[vtk-developers] VTK Nightly Doxygen missing classes

[Marcus D. Hanwell]

It looks like they are all there now,

http://www.vtk.org/doc/nightly/html/classvtkActor.html

There are several other little conditions in there right now such as
the header name must begin with vtk to be processed, please let me
know if you spot any that are missing. We should be able to get the
patch approved today so that future regenerations will work as
expected.

Marcus

On Tue, Aug 27, 2013 at 11:13 PM, Marcus D. Hanwell
<marcus.hanwell at kitware.com> wrote:
> Just running this manually, but it looks like that method defaults to
> die if it can't wrap a line, changing it to overflow seems to result
> in all headers being translated to Doxygen.
>
> http://review.source.kitware.com/#/t/3181
>
> It looks like this has always been the case, but the order may have
> changed causing more noticeable classes to be skipped. My eyes are
> bleeding a little after looking at Perl for so long, but I think this
> resolves the issue. I would love to switch to directly running Doxygen
> on our headers without all the steps in Perl...
>
> Marcus
>
> On Tue, Aug 27, 2013 at 8:07 PM, Marcus D. Hanwell
> <marcus.hanwell at kitware.com> wrote:
>> It looks like something in one of the headers is causing this error,
>>
>> This shouldn't happen at /usr/share/perl5/core_perl/Text/Wrap.pm line 84.
>>
>> Perl is not being super helpful in showing me what caused this to
>> happen, but it is actually at step one where the real headers are
>> converted to Doxygen headers. Google points to some kind of issue with
>> "wide characters" possibly being the culprit - I am going to say
>> "J'accuse!" ;-) A very small number of the headers actually get
>> translated, and so very few headers are currently visible to Doxygen
>> once it is invoked many steps later.
>>
>> Marcus
>>
>> On Tue, Aug 27, 2013 at 7:30 PM, Marcus D. Hanwell
>> <marcus.hanwell at kitware.com> wrote:
>>> I am still digging into this, but for anyone following along (or who
>>> might be more familiar with an ancient programming language called
>>> Perl) it is step 6 of 13 in there, the offending line looks to be,
>>>
>>>  => 301 found, 1401 orphan class(es) removed (vtkCellCentersPointPlacer, ...
>>>
>>> vtkActor and  friends are among that number, now I will try to
>>> understand how it decides classes are orphaned and should be removed.
>>>
>>> Marcus
>>>
>>> On Mon, Aug 26, 2013 at 1:37 PM, Marcus D. Hanwell
>>> <marcus.hanwell at kitware.com> wrote:
>>>> No, they are enabled for this build, but it really just works on the
>>>> headers in the source tree anyway. That build has enable all modules
>>>> on, which builds rendering etc.
>>>>
>>>> On Mon, Aug 26, 2013 at 1:02 PM, Utkarsh Ayachit
>>>> <utkarsh.ayachit at kitware.com> wrote:
>>>>> Could it be just a matter of ensuring all the modules are enabled?
>>>>>
>>>>> On Mon, Aug 26, 2013 at 1:01 PM, Marcus D. Hanwell
>>>>> <marcus.hanwell at kitware.com> wrote:
>>>>>> On Mon, Aug 26, 2013 at 12:42 PM, Utkarsh Ayachit
>>>>>> <utkarsh.ayachit at kitware.com> wrote:
>>>>>>> The VTK nightly doxygen generated documentation is missing several
>>>>>>> classes, e.g. vtkActor is not present.
>>>>>>>
>>>>>>> http://www.vtk.org/doc/nightly/html/classes.html
>>>>>>>
>>>>>>> Is this a known issue?
>>>>>>>
>>>>>> I wasn't aware of it, it certainly used to be there. I can take a look
>>>>>> and see if I can spot any errors in the logs. There are quite a few
>>>>>> Perl steps between us and Doxygen, so it can be challenging to debug.
>>>>>>
>>>>>> Marcus