XML documentation?

My biggest hurdle of using imgui is the lack of built in documentation. I know that the end of line comments in imgui.h are all over the place and probably not always useful without a context, but it would be extremely helpful to convert a line like this…

IMGUI_API void          Dummy(const ImVec2& size);                                      // add a dummy item of given size. unlike InvisibleButton(), Dummy() won't take the mouse click or be navigable into.

into …

///<summary>
/// add a dummy item of given size. unlike InvisibleButton(), Dummy() won't take the mouse click or be navigable into.
///</summary>
public static void Dummy(Vector2 size);

I would be very happy to contribute manual formatting of the original header file to help with this.

[mellinoe]

@sonoro1234 That is pretty cool! I’ll be taking a closer look sometime soon.

[sonoro1234]

@mellinoe @pixtur @ocornut Just pushed this https://github.com/cimgui/cimgui/tree/keep_text as an initial phase waiting for your comments

My comments

• Initial spaces and “\n” and // should be stripped
• assing comment to function only if it is in the same line (see: RenderText) (corrected now)
• Comments before an struct or enum should go to a field, but as they are json arrays of their members it cant be done in json (Lua can have mixing of array and collection in a table) there are two solutions: 1- transform structs and enum to collections, one field is comments the other is the array of its members. 2- Create a separate collection with key being struct or enum name and value the comment.