chipsalliance
No Public scaladoc for noPrefix, prefix APIs
Type of issue: documentation
Impact: no functional change
Development Phase: request
Other information
If the current behavior is a bug, please provide the steps to reproduce the problem:
Because prefix and noPrefix are aliases to private internal APIs, they don't get documented on the public API docs.
There is lots of good scaladoc here for noPrefix for example
https://github.com/chipsalliance/chisel3/blob/2b48fd15a7711dcd44334fbbc538667a102a581a/core/src/main/scala/chisel3/internal/prefix.scala#L68
But that is pretty much invisible to the user. You can't even find noPrefix searching on the API docs because it is a val member, you have to know where to find it to see it at all, and you don't get the scaladoc:
What is the current behavior?
- Searching for noPrefix (or prefix) i find nothing. I have to know to go to the chisel3.internal.package and look at Value Members, and then I still get no useful information about the API.
What is the expected behavior?
- Searching for
noPrefixon the API docs should get me to it, with all the nice scaladoc available.
I am labeling this as good first issue, though I'm not sure the right fix here. Should we put a full alias object in experimental with all the nice scaladoc that calls into internal?
Please tell us about your environment:
version 3.5.4 live on the website
What is the use case for changing the behavior?
There is excellent scaladoc here but it is very hard to discover and undestand the APIs. They are mentioned in the Naming Cookbook, but then it's confusing when you can't then search for them in the API docs.
