akka / akka-http

The Streaming-first HTTP server/module of Akka
https://doc.akka.io/libraries/akka-http/current/
Other
1.34k stars 594 forks source link

FormData.fromPath is missing from scaladoc #2052

Open raboof opened 6 years ago

raboof commented 6 years ago

https://doc.akka.io/api/akka-http/current/akka/http/scaladsl/model/FormData$.html does not show the fromPath method.

kornelrabczak commented 6 years ago

@raboof there is no such method as fromPath in FormData. Maybe you meant Multipart.FormData, but there is scaladoc for it already ;)

raboof commented 6 years ago

Ha, I think I confused those two before :laughing:

Indeed there is scaladoc, but it does not appear when searching for fromPath. Sounds like an 'upstream' scaladoc generation error?

jiminhsieh commented 6 years ago

I did some experiments. I found the search box cannot find the methods of the nested class and the nested object. For example, https://github.com/akka/akka-http/blob/409b8399fc2a0b412958b8b59f5dda15f370b902/akka-http/src/main/scala/akka/http/scaladsl/server/util/TupleOps.scala#L60-L64 and https://github.com/akka/akka-http/blob/409b8399fc2a0b412958b8b59f5dda15f370b902/akka-http/src/main/scala/akka/http/scaladsl/server/util/TupleOps.scala#L48-L52

kornelrabczak commented 6 years ago

There is an index file for scaladoc https://doc.akka.io/api/akka-http/current/index.js. It looks like scaladoc is only indexing nested classes/objects/traits but not their methods.