Add comment parsing from CastXML. #130
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
3 tasks
There was a problem hiding this comment.
Looks good as a starting point - thanks!
Would be nice if the declarations structure had some more contract enforcement.
My main nit here is that I'm not a huge fan of returning lines themselves. Can you instead retur the concatenated text, incorporating the columns too?
Add the additional properties from CastXML. Add location as a proper property Add type checks for the non-int properties.
Add __files_text to the scanner object. It is a dictionary of file declaration to the content of each file in a list of strings. The first time a comment is a part of a file, read it in and store it in the dictionary. Each time afterwards, use the stored value to capture the lines. Use the (begin/end) columns to more precisely capture the text of each comment. Update the test to remove extra characters.
Expand the comment test to capture the comments found on variables in a class.
tom-osika
reviewed
Oct 9, 2020
tom-osika
reviewed
Oct 9, 2020
Text taken from review suggestions.
|
I saw CastXML also tests comments before namespaces, enums, etc. Would it be worth adding some of those here? |
Expand the comment attribute reading to Namespace and Enumeration objects. Add tests for each of those objects.
Since the CastXML repository has the code for the comments but has not generated a release yet, check the version of the castxml executable before running. If it is 0.3.6 or older, do not run the test. Fix style errors.
josephsnyder
force-pushed
the
add_castxml_commenting
branch
from
25d1147 to
c59db5c
Compare
|
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 |
Stop trying to check the version with a regex and instead copy the "Nightly" version of castxml available from data.kitware.com. This Nightly version is master on October 14, 2020
josephsnyder
force-pushed
the
add_castxml_commenting
branch
from
67ab81b to
624ffcc
Compare
iMichka
reviewed
Oct 14, 2020
Switch from using a declaration as the parent class of a comment. Instead, create a comment_t object for each declaration.
Enforce that the resultant object found in the comment property is a comment_t object.
For new comment test, ensure that the text is found to be not empty before checking content. This should prevent failures on older versions of CastXML.
Since comment_t no longer is a declaration_t child, add a new check in startElement for a comment object. Add it to a new dictionary just for comments. Remove leftover debugging statement.
Add a comment text checking function. This print extra print signals when the test passes thanks to the absence of strings as opposed to the content matching.
iMichka
reviewed
Oct 22, 2020
iMichka
reviewed
Oct 22, 2020
Only use the start and end columns on the first and last line of the comment. Previously, a shorter line at the end would result in the previous lines leaving information behind.
To be consistent, add the explicit check for "is not None" when checking for the presence of a comment.
Use the start column of the comment on each line. Use the end column only on the last line.
|
Is this ready to go now? |
|
Yes, I believe that the backwards compatibility has been addressed and that it is ready for it's proper review |
tom-osika
reviewed
Oct 23, 2020
Fix spelling and copy/paste errors in the documentation of the properties of the comment_t object.
tom-osika
approved these changes
Oct 23, 2020
iMichka
approved these changes
Oct 23, 2020
|
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? |
|
Thank you, @iMichka, that will be just fine. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.