Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings
This repository was archived by the owner on Jan 6, 2023. It is now read-only.

Commit 3a2a9fd

Browse files
📝 Documented Everything Else !
1 parent b4af988 commit 3a2a9fd

File tree

3 files changed

+224
-0
lines changed

3 files changed

+224
-0
lines changed

‎src/SomeUtils/DynamicArray/README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# SomeUtils/DynamicArray;
2+
3+
```java
4+
package SomeUtils.DynamicArray;
5+
```
6+
7+
---
8+
9+
## DynamicArray.java
10+
11+
```java
12+
import SomeUtils.DynamicArray.DynamicArray;
13+
```
14+
---
15+
16+
### Public Methods
17+
18+
---
19+
20+
```java
21+
public DynamicArray();
22+
public DynamicArray(final T[] newArr);
23+
```
24+
25+
Create an instance with or without an initial array.
26+
27+
---
28+
29+
```java
30+
public void set(final int ind, final T value);
31+
```
32+
33+
Set the value for the specified index.
34+
35+
---
36+
37+
```java
38+
public T get(final int ind);
39+
```
40+
41+
Get the value for the specified index.
42+
43+
---
44+
45+
```java
46+
public T[] getArray();
47+
```
48+
49+
Get the fixed-length internal array.
50+
51+
---

‎src/SomeUtils/ProgressBar/README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# SomeUtils/ProgressBar
2+
3+
```java
4+
package SomeUtils.ProgressBar;
5+
```
6+
7+
---
8+
9+
## ProgressBar.java
10+
11+
```java
12+
import SomeUtils.ProgressBar.ProgressBar;
13+
```
14+
---
15+
16+
### Public Methods
17+
18+
---
19+
20+
```java
21+
public ProgressBar(); //SUFFER
22+
```
23+
24+
An unrecommended way of initializing the ProgressBar...
25+
26+
...Since it only provides suffering.
27+
28+
---
29+
30+
```java
31+
public ProgressBar(final int maxVal);
32+
public ProgressBar(final int minVal, final int maxVal);
33+
```
34+
35+
Two recommended ways of initializing the ProgressBar.
36+
37+
---
38+
39+
```java
40+
public int getValue();
41+
public int getMaxValue();
42+
public int[] getValues();
43+
```
44+
45+
Gets either the progress or the max value the ProgressBar can hold...
46+
47+
---
48+
49+
```java
50+
public void setValue(final int newValue);
51+
public void addValue();
52+
public void deductValue();
53+
```
54+
55+
Sets the value of the progress in three different ways...
56+
57+
...By setting the value yourself, adding or deducting to it.
58+
59+
---
60+
61+
```java
62+
public void printBar();
63+
```
64+
65+
Prints the ProgressBar itself.
66+
67+
---

‎src/SomeUtils/TerminalMap/README.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# SomeUtils/TerminalMap
2+
3+
```java
4+
package SomeUtils.TerminalMap;
5+
```
6+
7+
---
8+
9+
## TerminalMap.java
10+
11+
```java
12+
import SomeUtils.TerminalMap.TerminalMap;
13+
```
14+
---
15+
16+
### Public Variables
17+
18+
---
19+
20+
```java
21+
public static final char fullBlock; //█
22+
public static final char midFullBlock; //▆
23+
public static final char empty; //░
24+
public static final char occupied; //▓
25+
```
26+
27+
These variables are placeholders for different types of blocks.
28+
29+
---
30+
31+
### Public Methods
32+
33+
---
34+
35+
```java
36+
public TerminalMap();
37+
public TerminalMap(final int width, final int height);
38+
public TerminalMap(final char[][] newMap); //throws Exception
39+
```
40+
41+
Initialize either by setting the map's width and height...
42+
43+
...Or by dangerously creating a map yourself...
44+
45+
...Or by letting the class create a 3x3 map itself.
46+
47+
---
48+
49+
```java
50+
public void setMap(final char[][] newMap); //throws Exception
51+
```
52+
53+
Manually setting the map yourself.
54+
55+
---
56+
57+
```java
58+
public void set(final int x, final int y, final char in);
59+
```
60+
61+
Set the x and y coordinates of the map into the specified char.
62+
63+
---
64+
65+
```java
66+
public char get(final int x, final int y){
67+
```
68+
69+
Get the character in the map by the specified x and y coordinates.
70+
71+
---
72+
73+
```java
74+
//Row = horizontal
75+
public char[] getRow(final int y);
76+
//Column = vertical
77+
public char[] getColumn(final int x);
78+
```
79+
80+
Get the specified row or column.
81+
82+
---
83+
84+
```java
85+
public char[][] getMap();
86+
```
87+
88+
Get the internal map.
89+
90+
---
91+
92+
```java
93+
public void printMap();
94+
public void printMap(final boolean useBorders);
95+
public void printMap(final boolean useBorders, final boolean useThinnerBorders);
96+
```
97+
98+
Print the map with three different options...
99+
100+
...Print the map with the default configuration...
101+
102+
...Print the map with borders...
103+
104+
...Or print the map with thinner borders.
105+
106+
---

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /