https://github.com/i-al-istannen/doctor

A Discord bot serving Javadoc. Uses https://github.com/I-Al-Istannen/JavadocIndexer.
https://github.com/i-al-istannen/doctor

discord discord-bot discord-jda java javadoc jda

Last synced: 1 day ago
JSON representation

A Discord bot serving Javadoc. Uses https://github.com/I-Al-Istannen/JavadocIndexer.

• Host: GitHub
• URL: https://github.com/i-al-istannen/doctor
• Owner: I-Al-Istannen
• License: mit
• Created: 2021-07-25T14:35:24.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-24T16:13:04.000Z (5 months ago)
• Last Synced: 2024-06-24T17:51:07.293Z (5 months ago)
• Topics: discord, discord-bot, discord-jda, java, javadoc, jda
• Language: Java
• Homepage:
• Size: 2.11 MB
• Stars: 16
• Watchers: 3
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
Doc-Tor



Did you ever wish to tell somebody on discord to just read the (Java-)docs

while not being rude? Did you ever wish to point out some cool Java method or

class or highlight specific parts of the documentation?  

Then Doctor is for you :)

Doctor is best explained by a short demo:

https://user-images.githubusercontent.com/20284688/202914183-48fa576f-d6e2-4142-b5ea-5d12216f10a1.mp4

## Running Doctor

The Doctor jar file can be build using `mvn package` and just takes a single

argument:

```

java -jar Doctor.jar 

```

Most of the magic happens in the config file. You can see an example in

[`src/main/resources/config.toml`](src/main/resources/config.toml).