Skip to content
This repository was archived by the owner on Jan 1, 2023. It is now read-only.

Commit abfcfe5

Browse files
author
doomsdayrs
committed
Merge remote-tracking branch 'origin/master'
2 parents 71fe60e + d89724e commit abfcfe5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

Documentation.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
1-
#Documentation
1+
# Documentation
22
For version 1.1.0
33
+ [Introduction]()
44
+ Connection
55
+ Going down the objects
66

77

88

9-
##Introduction
9+
## Introduction
1010
So you want to use this wrapper? Well get ready, as it is as easy as 1 2 insert parameters.
1111
To get started, understand that i have never written one of these before. So good luck.
1212
Please also take note that this is a huge wrapper and i forget junk here and there. So enjoy errors every so often.
1313

1414
All returns from jikan are as CompletableFutures. So you can have async computing!
1515

16-
##How this wrapper works
16+
## How this wrapper works
1717
There is a single class that communicates to jikan and back, this class is the [Retriever](https://github.com/Doomsdayrs/Jikan4java/blob/master/src/main/java/com/github/Doomsdayrs/Jikan4java/core/Retriever.java).
1818
The class is the parent class of many objects within this wrapper, being the main driving force for parsing and communication.
1919
You can use this class to bypass the convenient pre-built objects to parse data. But do so at your own risk, as you need to make all the URLs yourself.
2020

2121
The Retriever class parents two main classes, the [Connector](https://github.com/Doomsdayrs/Jikan4java/blob/master/src/main/java/com/github/Doomsdayrs/Jikan4java/core/Connector.java) and
2222
the [Search](https://github.com/Doomsdayrs/Jikan4java/blob/master/src/main/java/com/github/Doomsdayrs/Jikan4java/core/search/Search.java) classes. These allow you to easily retrieve data from jikan with mostly no worries.
2323

24-
###Connector class
24+
### Connector class
2525
If you peak at the code of the class [Connector](https://github.com/Doomsdayrs/Jikan4java/blob/master/src/main/java/com/github/Doomsdayrs/Jikan4java/core/Connector.java), you can see that this class takes care of most operations.
2626

2727
An example of usage is as following
@@ -41,7 +41,7 @@ public class Main{
4141
```
4242
The above prints out the results of seasonLater search, it can also be used to assign variables with option B;
4343

44-
###Search objects
44+
### Search objects
4545
If you look into the code of [Search](https://github.com/Doomsdayrs/Jikan4java/blob/master/src/main/java/com/github/Doomsdayrs/Jikan4java/core/search/Search.java), you can see it is the parent object of multiple classes (go up the directory)
4646

4747
An example of usage would be the following
@@ -89,4 +89,4 @@ public class Main{
8989
* Method A uses a child object to retrieve a more complex querying of Manga; there is also a similar class for Anime.
9090
* Method B uses the search class with appropriate parameters (PersonPage, MangaPage,CharacterPage,AnimePage) and a secondary Type reinforcements (if they are mismatched an ERROR is 100% likely to occur). Method A first searches for someone with a limit of 2, then it gets the first one, then it retrieves someone by their ID.
9191

92-
These are the basic things you should know, ask questions on the main discord server to the dev (me) Clocks.
92+
These are the basic things you should know, ask questions on the main discord server to the dev (me) Clocks.

0 commit comments

Comments
 (0)