Try to enable deny(missing_docs) and fix any ignore code blocks in docs

ahayzen-kdab commented 2 years ago

Try to enable #![deny(missing_docs)] in all crates and ensure any ```ignore are removed from code blocks so we have real code blocks

[x] ~book~ - this is harder and might need mdbook-keeper https://github.com/rust-lang/mdBook/issues/706 so maybe not worth it as these are mostly included from real examples
[x] cxx-qt - #456
[x] cxx-qt-build - #456
[x] cxx-qt-gen - #880
[ ] cxx-qt-lib
[x] cxx-qt-lib-headers - #456
[x] qt-build-utils - #880

https://doc.rust-lang.org/rustdoc/lints.html#missing_docs

ahayzen-kdab commented 8 months ago

cxx-qt-lib has many to fix :-)

error: could not compile `cxx-qt-lib` (lib) due to 324 previous errors

LeonMatthesKDAB commented 1 month ago

Suggestion for cxx-qt-lib:

On every type, we add a link to the corresponding Qt documentation. Then we add #[allow(missing_docs)] on all methods that are a 1:1 wrap of a Qt API that doesn't need further comment.

Anything that is different from Qt API, we add a doc comment on.

KDAB / cxx-qt

Try to enable deny(missing_docs) and fix any ignore code blocks in docs #21