windows-rs icon indicating copy to clipboard operation
windows-rs copied to clipboard

`windows-bindgen` needs documentation

Open Alovchin91 opened this issue 3 years ago • 1 comments

Motivation

It’s close to impossible to use windows-bindgen without documentation.

Drawbacks

None

Rationale and alternatives

The Gen class has mysterious fields with cryptic names which say nothing about what are those, how and why they should be used etc.

Additional context

No response

Alovchin91 avatar Jan 01 '22 01:01 Alovchin91

Its early days but yes docs for the bindgen crate are needed as I expect developers to eventually use this crate directly.

kennykerr avatar Jan 03 '22 17:01 kennykerr

The windows-bindgen crate is now dramatically simpler than it was back when this issue was opened. It now also has some rudimentary function comments. Hopefully, that suffices for the time being. I still have a lot planned for bindgen and metadata, but it's pretty functional and straightforward today so I'll close this out for now.

Related to #2396 and #2399.

kennykerr avatar Mar 28 '23 18:03 kennykerr