search

Kapeli / javadocset

Simple command line tool for generating a Dash docset from Javadoc-generated documentation
114 stars 26 forks source link

Namespace methods with their class name #15

Closed FichteFoll closed 11 months ago

FichteFoll commented 3 years ago

Some methods in Java are overloaded a lot, such as List or Set methods, or they just occure quite frequently due to name collisions. However, in the docset the entry names only include the method name and not the class, which makes navigating to the one that you need quite a task, whereas the Python docset includes the module (and class) name and makes navigation a lot easier.

2021-11-05_12-50-18_zeal_java-addAll

2021-11-05_12-51-20_zeal_python-update

FichteFoll commented 11 months ago

Is this something you would be interested in in general? I run into this problem quite frequently when I work with Java and I always get annoyed by it. However, I don't have a Mac and don't know Objective-C, so it's not exactly something I can implement myself.

What I'm imagining is for to be prefixed by the package namespace and then separated from the function name by a hash sign, because that's how JavaDoc references class members in {@link} and others. For a method like addAll in the above screenshot, that would then become (signatues omitted):

This information is at least available on each packge and constructed from the package name and the class name.

FichteFoll commented 11 months ago

I also wanted to report the same issue for the Haskell docset, but didn't find a repo for it. Could you point me to where I can create that?

Kapeli commented 11 months ago

This isn't something that affects Dash so it's unlikely it'll ever be changed. Sorry. This is how it looks in Dash:

Screenshot 2023-12-11 at 10 43 32

FichteFoll commented 11 months ago

Can you also query for LdapName#addAll or (LdapName.addAll) in Dash to narrow down the results? Does the Haskell docset have the same metadata?

Kapeli commented 11 months ago

Not currently, but "LdapName addAll" works. Screenshot for Haskell:

Screenshot 2023-12-11 at 13 28 42

FichteFoll commented 11 months ago

Thanks. I'll see about adding this to Zeal. Sounds simpler than modifying multiple docsets anyway, if this information is already there somewhere.

FichteFoll commented 11 months ago

Closing since I created an issue for Zeal now. Unfortunately I don't have time to get into an unfamiliar code base written in a largely unfamiliar languagge at the moment. Thanks again for your speedy replies.