Support for doc comments in icrate generation #435
Conversation
| @@ -0,0 +1,126 @@ | |||
| //! Utilities for manipulating C/C++ comments. | |||
There was a problem hiding this comment.
I copied this file straight out of bindgen and then modified it for some of the extra gross objective-c comments.
There was a problem hiding this comment.
Could you leave attribution in the file? I think that should alleviate most licensing issues (they have a different license than us), but IANAL.
There was a problem hiding this comment.
Oh, I remember trying this before I discovered the "-fretain-comments-from-system-headers" flag, and then never got back to it, but this is really nice!
My biggest complaint is that the generated doc strings have various type annotations meant for something like sphinx. It makes them just kinda gross.
Yeah, I can see a few options for resolving that:
Entity::get_parsed_comment, if it handles those tags? If not, maybe it's possible to turn on aclangfeature flag to handle that?- Shell out to some sort of external
sphinxparser. - Investigate how Xcode handles them normally, maybe use their implementation (if it's open-source, probably difficult otherwise)
But it's still better than nothing.
Also, some of the comments don't work great with some of the macros.
Yeah, typed_enum, typed_extensible_enum and extern_static need a $(#[$m:meta])* in their definition, should be fairly simple (see icrate/src/macros.rs).
crates/header-translator/src/stmt.rs
Outdated
| @@ -447,12 +455,14 @@ impl Stmt { | |||
| designated_initializers, | |||
| derives: data.map(|data| data.derives.clone()).unwrap_or_default(), | |||
| ownership: data.map(|data| data.ownership.clone()).unwrap_or_default(), | |||
| comment: comment.clone(), | |||
There was a problem hiding this comment.
I don't think it makes sense to duplicate the comment on the class to the Methods and ProtocolImpl. Sure, impl MyClass and impl MyProtocol for MyClass won't have any comments associated with them if we don't clone it, but I think that's better.
Same goes for ProtocolImpl in categories.
| @@ -0,0 +1,126 @@ | |||
| //! Utilities for manipulating C/C++ comments. | |||
There was a problem hiding this comment.
Could you leave attribution in the file? I think that should alleviate most licensing issues (they have a different license than us), but IANAL.
…ts-to-header-translator
I'm not sure there's an issue for this but saw the
TODOand felt like doing it. My biggest complaint is that the generated doc strings have various type annotations meant for something like sphinx. It makes them just kinda gross.Also, some of the comments don't work great with some of the macros.