search

fzi-forschungszentrum-informatik / catkin_doc

Tool for automatic ROS-API documentation generation
BSD 3-Clause "New" or "Revised" License
1 stars 2 forks source link

doxygen supported? #2

Open gavanderhoorn opened 4 years ago

gavanderhoorn commented 4 years ago

From the example section in the readme it appears that 'special notation' is required to benefit from automated extraction of comments.

The suggested notation seems to be different from Doxygen's, which is probably what quite a few packages already use (as it is a recommended best practice).

I haven't verified whether it's already supported, but it would be good to avoid requiring different syntax than Doxygen, as it will both increase potential adoption of catkin_doc and reduce effort required on the side of the developer.

fmauch commented 4 years ago

I had a similar thought earlier this day. I was not so sure about that, as Doxygen is usually used inside header files, while the commands parsed here are more likely to be found in implementation files.

Up until now we don't support any special syntax, but supporting Doxygen syntax would be my favorite one, as well.