Document how to add comments in an IDL file for fastrtpsgen

Question

Document how to add comments in an IDL file for fastrtpsgen

Closed this issue 5 years ago · 4 comments

I have been looking for somewhere that documents how to add comments to IDL files used by fastrtpsgen. This would be helpful to know about. I ended up trying regular C++ comments, and that seemed to work, but it should be documented somewhere. If it is, please point me to that documentation. Also, it would be nice to have more examples of idl files in the documentation (ones that use enums and structs within structs, things like that). Thanks!

realdealneil commented 5 years ago

Closed

Answer 1 · 2020-06-17T10:43:31.000Z

Hi @realdealneil ,

Sorry for the late response. As you say, comments similar to C++ style are supported in IDL file. We are right now expanding out Fast DDS-Gen documentation in #165 and will most definitely include your suggestion. In the mean time, you can take a look at the Interface Definition Language v4.2 standard, which is what Fast DDS-Gen implements. Specifically, section 7.2.2 describes how to comment and IDL.

Thanks for picking that up a putting the time to make the suggestion.

Answer 2 · 2020-06-18T11:47:15.000Z

Hi @realdealneil ,

We have effectively merger #165 now, adding a section about IDL comments. You can see it here.

Please do tell us if you consider it to be thorough enough, and if so, please close this issue.

Answer 3 · 2020-06-18T21:45:19.000Z

Thanks, looks good! Closing.