Generate documentation for type aliases/definitions

[bobogei81123]

I'm facing similar problem to this stack overflow question.

Specifically, I made a wrapper class that wraps around an FFI object and creates common functionality like from_ffi, etc.

pub struct FfiWrapper<T>(T);

impl<T> FfiWrapper<T> {
  fn from_ffi(t: T) -> Self { ... }
}

Then, I implemented different methods based on the FFI type:

/// Some docs for type A
type A = FfiWrapper<FfiA>

impl A {
  /// Some docs for method_a
  fn method_a(self) ...
}

Yet, rust doc generate item and doc for type A = FfiWrapper<FfiA>, but not for fn method_a. How can I let the items in the specific implementation show up in docs?

[syphar]

Hi,
this repo is about docs.rs, which is just a builder & hoster for the documentation generated by rustdoc.

I assume this can be either directly answered by folks more versed with rustdoc, or has to be moved to the rust-lang/rust repo where rustdoc issues are kept.

cc @Nemo157 @GuillaumeGomez ?

[GuillaumeGomez]

You need to make method_a public.

[bobogei81123]

Hey, sorry for reporting to the wrong place.

I found out that what happened is that the wrapper is private but the type alias is public:
For example:

mod wrapper {
    #[repr(transparent)]
    pub struct Wrapper<T>(T);

    impl<T> Wrapper<T> {
        /// Common method
        pub fn common() {}
    }
}

pub mod a {
    use crate::wrapper::Wrapper;

    pub struct A;
    pub type WA = Wrapper<A>;

    impl WA {
        /// Type specific method
        pub fn method_a() {}
    }
}

The code compiles without any error and warning (See rust playground). Yet, if you run rust doc then no doc will be generated for Wrapper::common and WA::method_a.

[GuillaumeGomez]

For the missing impl on the type alias, I made #112429 but we needed to revert it because it introduced some bugs. We'll need to wait for the trait system rewrite to be done before I can put back the fix again.

[fmease]

Fixed by #115201, right?