Re: [Discuss-gnuradio] Problem with new swig docs stuff

[Tom Rondeau]

On Wed, Dec 7, 2011 at 1:06 PM, Ben Reynwar <address@hidden> wrote:

On Tue, Dec 6, 2011 at 3:51 PM, Josh Blum <address@hidden> wrote:
>

>> <snip>
>> [ 47%] Generating general_swig_doc.i
>> Error in xml in file /home/gr/source/git/gnuradio/build/gnuradio-core/src/lib/swig/general_swig_doc_swig_docs/xml/gr__simple__framer__sync_8h.xml
>> Traceback (most recent call last):
>>   File "/home/gr/source/git/gnuradio/docs/doxygen/swig_doc.py", line 253, in <module>
>>     make_swig_interface_file(di, swigdocfilename, custom_output=custom_output)
>>   File "/home/gr/source/git/gnuradio/docs/doxygen/swig_doc.py", line 196, in make_swig_interface_file
>>     blocks = di.in_category(Block)
>>   File "/home/gr/source/git/gnuradio/docs/doxygen/doxyxml/base.py", line 140, in in_category
>>     self.confirm_no_error()
>>   File "/home/gr/source/git/gnuradio/docs/doxygen/doxyxml/base.py", line 206, in confirm_no_error
>>     self.check_parsed()
>>   File "/home/gr/source/git/gnuradio/docs/doxygen/doxyxml/base.py", line 203, in check_parsed
>>     self._parse()
>>   File "/home/gr/source/git/gnuradio/docs/doxygen/doxyxml/doxyindex.py", line 51, in _parse
>>     self._members += converted.members()
>>   File "/home/gr/source/git/gnuradio/docs/doxygen/doxyxml/base.py", line 174, in members
>>     self.confirm_no_error()
>>   File "/home/gr/source/git/gnuradio/docs/doxygen/doxyxml/base.py", line 206, in confirm_no_error
>>     self.check_parsed()
>>   File "/home/gr/source/git/gnuradio/docs/doxygen/doxyxml/base.py", line 203, in check_parsed
>>     self._parse()
>>   File "/home/gr/source/git/gnuradio/docs/doxygen/doxyxml/doxyindex.py", line 163, in _parse
>>     self.set_descriptions(self._retrieved_data.compounddef)
>> AttributeError: 'NoneType' object has no attribute 'compounddef'
>> make[2]: *** [gnuradio-core/src/lib/swig/general_swig_doc.i] Error 1
>> make[1]: *** [gnuradio-core/src/lib/swig/CMakeFiles/_gnuradio_core_filter.dir/all] Error 2
>> make: *** [all] Error 2
>>
>
> Tom/Ben,
>
> I think doxyindex.py may be relying on an xml field that older doxygen's
> do not define.
>
> Perhaps we could put a big try/catch around this in case it fails and
> print to stderr. That way the build keeps going, and its just a warning
> printed out in the terminal.
>
> -josh

You're right, it clearly needs to be more robust.  I'll have a look tonight.

Ben

It turns out that the problem was with the '&' in the doxygen markup. I was able to change this link to one that doesn't use '&'. it also looks like this is a problem with old Doxygen format.

Hopefully, we won't see this again or Ben can put in a quick fix for it.

I have also updated the build process such that if you specify '-DENABLE_DOXYGEN=False' it does not build the swigdocs, either. So any future problems that might occur due to issues with markup, etc., we can at least get around by not having these guys generated at all.

(I would also like to stop having to support Redhat, but I know too many places are still using it.)

Tom