pseudomuto / protoc-gen-doc

Documentation generator plugin for Google Protocol Buffers
MIT License
2.61k stars 462 forks source link

I can't get the struct detail which is imported from other proto file #420

Open cnjack opened 4 years ago

cnjack commented 4 years ago

for example:

import "xxx/core/list_settings.proto"
message BookList {
    core.ListPagination setting = 1;
}

I can just get that:

| Field | Type | Description |
| ----- | ---- | ----------- |
| setting | [core.ListPagination](#core.ListPagination)  |  |
Field Type Description
setting core.ListPagination

but it has't the detail of the #core.ListPagination

cnjack commented 4 years ago

@estan

plaisted commented 4 years ago

Have the same issue. I can resolve by including the referenced proto files directly when creating documentation but somewhat cumbersome and leads to a bunch of noise in the documentation if the other proto files have a bunch of messages not used by the ones I'm creating documentation for.