GSoC 2024- Scaladoc Search in Protosearch

[golden-skipper03]

This pull request introduces key features to integrate Scaladoc search into Protosearch, making it easier to search through documentation contained within Scala source files.

Key changes-

1. Scaladoc parsing- Added functionality to parse Scaladoc comments to extract important information such as function names, descriptions, parameters, type parameters, annotations, implicit parameters.
2. Scaladoc Indexing- Created a module to index parsed Scaladoc content using existing protosearch indexing data structures so that users can quickly search and retrieve documentation.
3. UI Changes- Enhanced the user interface to support searching over index.
4. A new sbt plugin, ProtosearchScaladocPlugin, has been developed by mentor, Andrew Valencik as a convenience to help the construction of indexes using the parsing and indexing module.

Visible changes-

Instructions to follow-

1. Follow contribution tutorial for setting up protosearch.
2. Inside the project that you have chosen, run this command to create index- projectName/createScaladocIndex
3. Copy the created index inside site\target\docs\site\search directory
4. Launch a local webserver from the site directory (e.g. simple-http-server (https://github.com/TheWaWaR/simple-http-server) or python -m http.server
5. Go to url localhost:XXXX/search/search.html?index="indexName"&type=scaladoc

[valencik]

Thanks @golden-skipper03 for all your hard work on this!
I think we're getting very close to merge ready. I've left a handful of comments and change requests here, but they're mostly minor things. The bulk of your work here is done and working nicely :)

[golden-skipper03]

I also fixed the error that i got during the checks so it also passed all checks with this commit

[valencik]

Thanks for all the changes @golden-skipper03!

I think this is looking good now and we're ready to merge :)
Congrats on finishing up. I am eager to use this. 🎉