Skip to content

Commit 3f7fc89

Browse files
committed
Updated java-docs
1 parent 60c8fae commit 3f7fc89

6 files changed

Lines changed: 652 additions & 82 deletions

File tree

src/main/java/io/fi0x/javalogger/logging/LOG.java

Lines changed: 44 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,13 @@
66
*/
77
public class LOG
88
{
9+
private LOG()
10+
{
11+
}
912
/**
1013
* This method will create a log message with the INFO template.
11-
* @param message The message that will be displayed in the log.
14+
*
15+
* @param message The message that will be displayed in the log.
1216
* @param projectName The name of the project this log was created in.
1317
*/
1418
public static void INFO(String message, String projectName)
@@ -19,6 +23,7 @@ public static void INFO(String message, String projectName)
1923
}
2024
/**
2125
* This method will create a log message with the INFO template.
26+
*
2227
* @param message The message that will be displayed in the log.
2328
*/
2429
public static void INFO(String message)
@@ -28,10 +33,11 @@ public static void INFO(String message)
2833
}
2934
/**
3035
* This method will create a log message with the WARNING template.
31-
* @param message The message that will be displayed in the log.
36+
*
37+
* @param message The message that will be displayed in the log.
3238
* @param projectName The name of the project this log was created in.
33-
* @param errorCode The error code that will be displayed.
34-
* @param exception The exception that will be printed.
39+
* @param errorCode The error code that will be displayed.
40+
* @param exception The exception that will be printed.
3541
*/
3642
public static void WARN(String message, String projectName, int errorCode, Exception exception)
3743
{
@@ -43,7 +49,8 @@ public static void WARN(String message, String projectName, int errorCode, Excep
4349
}
4450
/**
4551
* This method will create a log message with the WARNING template.
46-
* @param message The message that will be displayed in the log.
52+
*
53+
* @param message The message that will be displayed in the log.
4754
* @param errorCode The error code that will be displayed.
4855
* @param exception The exception that will be printed.
4956
*/
@@ -56,9 +63,10 @@ public static void WARN(String message, int errorCode, Exception exception)
5663
}
5764
/**
5865
* This method will create a log message with the WARNING template.
59-
* @param message The message that will be displayed in the log.
66+
*
67+
* @param message The message that will be displayed in the log.
6068
* @param projectName The name of the project this log was created in.
61-
* @param errorCode The error code that will be displayed.
69+
* @param errorCode The error code that will be displayed.
6270
*/
6371
public static void WARN(String message, String projectName, int errorCode)
6472
{
@@ -69,9 +77,10 @@ public static void WARN(String message, String projectName, int errorCode)
6977
}
7078
/**
7179
* This method will create a log message with the WARNING template.
72-
* @param message The message that will be displayed in the log.
80+
*
81+
* @param message The message that will be displayed in the log.
7382
* @param projectName The name of the project this log was created in.
74-
* @param exception The exception that will be printed.
83+
* @param exception The exception that will be printed.
7584
*/
7685
public static void WARN(String message, String projectName, Exception exception)
7786
{
@@ -82,7 +91,8 @@ public static void WARN(String message, String projectName, Exception exception)
8291
}
8392
/**
8493
* This method will create a log message with the WARNING template.
85-
* @param message The message that will be displayed in the log.
94+
*
95+
* @param message The message that will be displayed in the log.
8696
* @param errorCode The error code that will be displayed.
8797
*/
8898
public static void WARN(String message, int errorCode)
@@ -93,7 +103,8 @@ public static void WARN(String message, int errorCode)
93103
}
94104
/**
95105
* This method will create a log message with the WARNING template.
96-
* @param message The message that will be displayed in the log.
106+
*
107+
* @param message The message that will be displayed in the log.
97108
* @param projectName The name of the project this log was created in.
98109
*/
99110
public static void WARN(String message, String projectName)
@@ -104,7 +115,8 @@ public static void WARN(String message, String projectName)
104115
}
105116
/**
106117
* This method will create a log message with the WARNING template.
107-
* @param message The message that will be displayed in the log.
118+
*
119+
* @param message The message that will be displayed in the log.
108120
* @param exception The exception that will be printed.
109121
*/
110122
public static void WARN(String message, Exception exception)
@@ -115,6 +127,7 @@ public static void WARN(String message, Exception exception)
115127
}
116128
/**
117129
* This method will create a log message with the WARNING template.
130+
*
118131
* @param message The message that will be displayed in the log.
119132
*/
120133
public static void WARN(String message)
@@ -124,10 +137,11 @@ public static void WARN(String message)
124137
}
125138
/**
126139
* This method will create a log message with the ERROR template.
127-
* @param message The message that will be displayed in the log.
140+
*
141+
* @param message The message that will be displayed in the log.
128142
* @param projectName The name of the project this log was created in.
129-
* @param errorCode The error code that will be displayed.
130-
* @param exception The exception that will be printed.
143+
* @param errorCode The error code that will be displayed.
144+
* @param exception The exception that will be printed.
131145
*/
132146
public static void ERROR(String message, String projectName, int errorCode, Exception exception)
133147
{
@@ -139,7 +153,8 @@ public static void ERROR(String message, String projectName, int errorCode, Exce
139153
}
140154
/**
141155
* This method will create a log message with the ERROR template.
142-
* @param message The message that will be displayed in the log.
156+
*
157+
* @param message The message that will be displayed in the log.
143158
* @param errorCode The error code that will be displayed.
144159
* @param exception The exception that will be printed.
145160
*/
@@ -152,9 +167,10 @@ public static void ERROR(String message, int errorCode, Exception exception)
152167
}
153168
/**
154169
* This method will create a log message with the ERROR template.
155-
* @param message The message that will be displayed in the log.
170+
*
171+
* @param message The message that will be displayed in the log.
156172
* @param projectName The name of the project this log was created in.
157-
* @param errorCode The error code that will be displayed.
173+
* @param errorCode The error code that will be displayed.
158174
*/
159175
public static void ERROR(String message, String projectName, int errorCode)
160176
{
@@ -165,9 +181,10 @@ public static void ERROR(String message, String projectName, int errorCode)
165181
}
166182
/**
167183
* This method will create a log message with the ERROR template.
168-
* @param message The message that will be displayed in the log.
184+
*
185+
* @param message The message that will be displayed in the log.
169186
* @param projectName The name of the project this log was created in.
170-
* @param exception The exception that will be printed.
187+
* @param exception The exception that will be printed.
171188
*/
172189
public static void ERROR(String message, String projectName, Exception exception)
173190
{
@@ -178,7 +195,8 @@ public static void ERROR(String message, String projectName, Exception exception
178195
}
179196
/**
180197
* This method will create a log message with the ERROR template.
181-
* @param message The message that will be displayed in the log.
198+
*
199+
* @param message The message that will be displayed in the log.
182200
* @param errorCode The error code that will be displayed.
183201
*/
184202
public static void ERROR(String message, int errorCode)
@@ -189,7 +207,8 @@ public static void ERROR(String message, int errorCode)
189207
}
190208
/**
191209
* This method will create a log message with the ERROR template.
192-
* @param message The message that will be displayed in the log.
210+
*
211+
* @param message The message that will be displayed in the log.
193212
* @param projectName The name of the project this log was created in.
194213
*/
195214
public static void ERROR(String message, String projectName)
@@ -200,7 +219,8 @@ public static void ERROR(String message, String projectName)
200219
}
201220
/**
202221
* This method will create a log message with the ERROR template.
203-
* @param message The message that will be displayed in the log.
222+
*
223+
* @param message The message that will be displayed in the log.
204224
* @param exception The exception that will be printed.
205225
*/
206226
public static void ERROR(String message, Exception exception)
@@ -211,6 +231,7 @@ public static void ERROR(String message, Exception exception)
211231
}
212232
/**
213233
* This method will create a log message with the ERROR template.
234+
*
214235
* @param message The message that will be displayed in the log.
215236
*/
216237
public static void ERROR(String message)

0 commit comments

Comments
 (0)