search

CastXML / pygccxml

pygccxml is a specialized XML reader that reads the output from CastXML or GCCXML. It provides a simple framework to navigate C++ declarations, using Python classes.
Boost Software License 1.0
129 stars 44 forks source link

Add comment parsing from CastXML. #130

Closed josephsnyder closed 3 years ago

josephsnyder commented 3 years ago

In CastXML 3.6, a new feature was introduced to capture the documentation comments added to the header files of the C++ sent through the program. Add the code to pygccxml to read those new comment nodes and attributes into a new "comment" declaration type.

tao558 commented 3 years ago

I saw CastXML also tests comments before namespaces, enums, etc. Would it be worth adding some of those here?

EricCousineau-TRI commented 3 years ago

In conjunction with @tao558's comment, would you be able to see what comments look like for this kind of Christmas-tree test in Drake? (or rather, can you check that pygccxml can generally analyze the symbols that mkdoc can currently parse using clang.cindex?) Code: sample_header.h Example output: sample_header_documentation.expected.h

billhoffman commented 3 years ago

Is this ready to go now?

josephsnyder commented 3 years ago

Yes, I believe that the backwards compatibility has been addressed and that it is ready for it's proper review

iMichka commented 3 years ago

Looks good. It's merged now. I'll let you use the latest develop version for a few days/weeks and we will cut a new release later if this OK for you?

josephsnyder commented 3 years ago

Thank you, @iMichka, that will be just fine.