1

I'm currently using a multi-package open source framework that exposes dozens of classes/objects as type aliases in a root package, apparently solely for the purpose of making wildcard importing easy.

unfortunately, because these type aliases have the same name as the actual qualified type, they always come up first in the search function, which wastes time and valuable screen space.

is there an annotation I can put in front of a type alias to stop it from showing up in search? I don't want to omit it entirely from the documentation, because it obviously isn't irrelevant, it's just that nobody would look for these aliases by name. also note that I'm generating these docs for my own personal perusal, so we don't need to debate whether hiding members from search is bad practice for a public framework.

PopKernel
  • 4,110
  • 5
  • 29
  • 51
  • 1
    If you want to build the code only for the purpose of generating scaladoc, perhaps you can make them `private[topLevelPackage]` e.g. `private[doobie]` or `private[org.http4s]`. – Jasper-M Aug 21 '22 at 11:37

0 Answers0