Skip to content

Commit 6206993

Browse files
SimplyProgrammerSimplyProgrammer
committed
fixing broken jdocs links, adding source generator and jdoc generator
1 parent df5babe commit 6206993

File tree

11 files changed

+69
-37
lines changed

11 files changed

+69
-37
lines changed

‎SerialX-core/src/main/java/org/ugp/serialx/Scope.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ public Scope(GenericScope<String, ?> sourceScope)
9393
/**
9494
* @param variablesMap | Initial variables to be added in to this scope!
9595
* @param values | Initial independent values to be added in to this scope!
96-
* @param | Parent of this scope.
96+
* @param parent | Parent of this scope.
9797
9898
* @since 1.3.5
9999
*/
@@ -103,7 +103,7 @@ public Scope(Map<String, ?> variablesMap, Collection<?> values, GenericScope<?,
103103
}
104104

105105
@Override
106-
public Scope clone()
106+
public Scope clone()
107107
{
108108
try
109109
{

‎SerialX-core/src/main/java/org/ugp/serialx/Utils.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ public static Object InvokeFunc(Object obj, String name, Object... args) throws
142142

143143
/**
144144
* @param obj | The object the underlying method is invoked from!
145-
* @param cls | Class to invoke method from.
145+
* @param objCls | Class to invoke method from.
146146
* @param name | Name of public static method to be called.
147147
* @param args | Arguments of method. Arguments should be certain if method is overloaded!
148148
*
@@ -165,7 +165,7 @@ public static Object InvokeFunc(Object obj, Class<?> objCls, String name, Object
165165

166166
/**
167167
* @param obj | The object the underlying method is invoked from!
168-
* @param cls | Class to invoke method from.
168+
* @param objCls | Class to invoke method from.
169169
* @param name | Name of public static method to be called.
170170
* @param argClasses | Classes of args.
171171
* @param args | Arguments of method. Arguments should be certain if method is overloaded!
@@ -447,8 +447,8 @@ public static StringBuilder multilpy(char ch, int times)
447447
}
448448

449449
/**
450-
* @param ch | String to multiply!
451-
* @param str | Count of multiplication!
450+
* @param str | String to multiply!
451+
* @param times | Count of multiplication!
452452
*
453453
* @return Multiplied char, for example <code>multilpy("a", 5)</code> will return "aaaaa";
454454
*

‎SerialX-core/src/main/java/org/ugp/serialx/converters/ProtocolConverter.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,9 @@ protected Object parse(ParserRegistry myHomeRegistry, Class<?> objClass, String
164164
}
165165

166166
@Override
167-
public CharSequence toString(ParserRegistry myHomeRegistry, Object arg, Object... args)
167+
public CharSequence toString(ParserRegistry myHomeRegistry, Object obj, Object... args)
168168
{
169-
return toString(myHomeRegistry, arg, null, args);
169+
return toString(myHomeRegistry, obj, null, args);
170170
}
171171

172172
/**
@@ -181,15 +181,15 @@ public CharSequence toString(ParserRegistry myHomeRegistry, Object arg, Object..
181181
* @since 1.3.5
182182
*/
183183
@SuppressWarnings("unchecked")
184-
public CharSequence toString(ParserRegistry myHomeRegistry, Object arg, SerializationProtocol<Object> preferedProtocol, Object... args)
184+
public CharSequence toString(ParserRegistry myHomeRegistry, Object obj, SerializationProtocol<Object> preferedProtocol, Object... args)
185185
{
186-
if (arg == null)
186+
if (obj == null)
187187
return CONTINUE;
188188

189-
if (useBase64IfCan && arg instanceof Serializable)
189+
if (useBase64IfCan && obj instanceof Serializable)
190190
return CONTINUE;
191191

192-
if (preferedProtocol != null || (preferedProtocol = (SerializationProtocol<Object>) getProtocolFor(arg, SerializationProtocol.MODE_SERIALIZE, args)) != null)
192+
if (preferedProtocol != null || (preferedProtocol = (SerializationProtocol<Object>) getProtocolFor(obj, SerializationProtocol.MODE_SERIALIZE, args)) != null)
193193
{
194194
Class<?> oldObjectClass = null;
195195
try
@@ -200,10 +200,10 @@ public CharSequence toString(ParserRegistry myHomeRegistry, Object arg, Serializ
200200
if (args.length < 5)
201201
args = Arrays.copyOf(args, 5);
202202
oldObjectClass = (Class<?>) args[4];
203-
args[4] = arg.getClass();;
203+
args[4] = obj.getClass();;
204204

205-
Object[] objArgs = preferedProtocol.serialize(arg);
206-
StringBuilder sb = new StringBuilder(ImportsProvider.getAliasFor(args.length > 0 ? args[0] : null, arg.getClass()) + (objArgs.length <= 0 ? "" : " "));
205+
Object[] objArgs = preferedProtocol.serialize(obj);
206+
StringBuilder sb = new StringBuilder(ImportsProvider.getAliasFor(args.length > 0 ? args[0] : null, obj.getClass()) + (objArgs.length <= 0 ? "" : " "));
207207

208208
args = args.clone();
209209
for (int i = 0, sizeEndl = 10000; i < objArgs.length; i++)
@@ -229,7 +229,7 @@ public CharSequence toString(ParserRegistry myHomeRegistry, Object arg, Serializ
229229
}
230230
catch (Exception e)
231231
{
232-
LogProvider.instance.logErr("Exception while serializing instance of \"" + arg.getClass().getName() + "\":", e);
232+
LogProvider.instance.logErr("Exception while serializing instance of \"" + obj.getClass().getName() + "\":", e);
233233
e.printStackTrace();
234234
}
235235
args[4] = oldObjectClass;

‎SerialX-core/src/main/java/org/ugp/serialx/converters/imports/ImportsProvider.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -196,7 +196,7 @@ public Imports(Collection<? extends Import> c)
196196
/**
197197
* Constructs an {@link Imports} with inserted imports.
198198
*
199-
* @param parsers | Initial content of registry.
199+
* @param imports | Initial content of registry.
200200
*
201201
* @since 1.3.5
202202
*/

‎SerialX-devtools/src/main/java/org/ugp/serialx/devtools/SerializationDebugger.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ public static <T extends Serializer> T debug(T serializer)
169169

170170
/**
171171
* @param serializer | Serializer to debug!
172-
* @param debuger | Specific debugger to use!
172+
* @param debugger | Specific debugger to use!
173173
*
174174
* @return Serializer capable of debugging its serialization and deserialization!
175175
*

‎SerialX-json/src/main/java/org/ugp/serialx/json/JsonSerializer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ public <A extends Appendable> A SerializeAsSubscope(A source, Object... args) th
229229
}
230230

231231
/**
232-
* @param jsonSerializer | JsonSerializer to create {@link JussSerializer} from!
232+
* @param jussSerializer | JussSerializer to create {@link JsonSerializer} from!
233233
*
234234
* @return JussSerializer created from JsonSerializer, all values and variables will remain intact!
235235
*

‎SerialX-juss/src/main/java/org/ugp/serialx/juss/JussSerializer.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ public Appendable GenerateComment(Appendable source, ParserRegistry registry, Ob
388388

389389
/**
390390
* @param reader | Reader to read from!
391-
* @param formatingArgs | Additional arguments to use. In case of JussSerializer, this should be array of length 4 with 0. argument will being this pointer of this scope (it can be also boolean signifying if formating is required), 1. and 2. argument are null (they are used by JUSS parsers) and argument 3. will be {@link ProtocolRegistry} used by this {@link Serializer}, and additional argument 4. being of type {@link Class} containing information about class that is curently being serialized (used primarily by {@link ObjectConverter}).
391+
* @param args | Additional arguments to use. In case of JussSerializer, this should be array of length 4 with 0. argument will being this pointer of this scope (it can be also boolean signifying if formating is required), 1. and 2. argument are null (they are used by JUSS parsers) and argument 3. will be {@link ProtocolRegistry} used by this {@link Serializer}, and additional argument 4. being of type {@link Class} containing information about class that is curently being serialized (used primarily by {@link ObjectConverter}).
392392
*
393393
* @return This scope after loading data from reader (you most likely want to return "this")!
394394
*
@@ -673,21 +673,21 @@ protected Object parseObject(ParserRegistry registry, String str, Object... pars
673673
}
674674

675675
/**
676-
* @param variable | Variable to clone!
676+
* @param variableKey | Variable to clone!
677677
*
678678
* @return Clone of value stored by variable with inserted name or null if there is no such a one!
679679
* <br><br>
680680
* Note: Cloning is done by {@link Serializer#Clone(Object, Registry, Object[], Object...))}!
681681
*
682682
* @since 1.3.2
683683
*/
684-
public <T> T cloneOf(String variableName)
684+
public <T> T cloneOf(String variableKey)
685685
{
686-
return cloneOf(variableName, null);
686+
return cloneOf(variableKey, null);
687687
}
688688

689689
/**
690-
* @param variable | Variable to clone!
690+
* @param variableKey | Variable to clone!
691691
* @param defaultValue | Default value to return.
692692
*
693693
* @return Clone of value stored by variable with inserted name or defaultValue if there is no such a one or given key contains null!
@@ -696,9 +696,9 @@ public <T> T cloneOf(String variableName)
696696
*
697697
* @since 1.3.2
698698
*/
699-
public <T> T cloneOf(String variableName, T defaultValue)
699+
public <T> T cloneOf(String variableKey, T defaultValue)
700700
{
701-
T obj = get(variableName, defaultValue);
701+
T obj = get(variableKey, defaultValue);
702702
if (obj == defaultValue)
703703
return defaultValue;
704704
return Clone(obj, getParsers(), new Object[] {-99999, 0, this, getProtocols(), isGenerateComments()}, this, null, null, getProtocols());

‎SerialX-juss/src/main/java/org/ugp/serialx/juss/converters/ObjectConverter.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,9 @@ public Object parse(ParserRegistry myHomeRegistry, String str, Object... compile
122122
}
123123

124124
@Override
125-
public CharSequence toString(ParserRegistry myHomeRegistry, Object arg, Object... args)
125+
public CharSequence toString(ParserRegistry myHomeRegistry, Object obj, Object... args)
126126
{
127-
return toString(myHomeRegistry, arg, null, args);
127+
return toString(myHomeRegistry, obj, null, args);
128128
}
129129

130130
/**
@@ -139,17 +139,17 @@ public CharSequence toString(ParserRegistry myHomeRegistry, Object arg, Object..
139139
* @since 1.3.5
140140
*/
141141
@SuppressWarnings("unchecked")
142-
public CharSequence toString(ParserRegistry myHomeRegistry, Object arg, SerializationProtocol<Object> preferedProtocol, Object... args)
142+
public CharSequence toString(ParserRegistry myHomeRegistry, Object obj, SerializationProtocol<Object> preferedProtocol, Object... args)
143143
{
144-
if (arg instanceof Scope)
144+
if (obj instanceof Scope)
145145
{
146146
Serializer serializer;
147147
try
148148
{
149-
if (arg instanceof Serializer)
150-
serializer = (Serializer) arg;
149+
if (obj instanceof Serializer)
150+
serializer = (Serializer) obj;
151151
else if (args.length > 0 && args[0] instanceof Serializer)
152-
(serializer = ((Serializer) args[0]).emptyClone()).addAll((GenericScope<String, ?>) arg);
152+
(serializer = ((Serializer) args[0]).emptyClone()).addAll((GenericScope<String, ?>) obj);
153153
else
154154
serializer = getPreferredSerializer();
155155
}
@@ -182,7 +182,7 @@ else if (args.length > 0 && args[0] instanceof Serializer)
182182
}
183183
}
184184

185-
return super.toString(myHomeRegistry, arg, preferedProtocol, args);
185+
return super.toString(myHomeRegistry, obj, preferedProtocol, args);
186186
}
187187

188188
@Override

‎SerialX-operators/src/main/java/org/ugp/serialx/converters/operators/ArithmeticOperators.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
public class ArithmeticOperators implements DataParser
2424
{
2525
/**
26-
* @deprecated DO NOT USE! USE {@link ArithmeticOperators#evalOperator(Object, String, Object)} AND {@link ArithmeticOperators#getOperatorPriority(String)} INSTEAD!
26+
* @deprecated DO NOT USE! USE {@link ArithmeticOperators#operator(Object, String, Object)} AND {@link ArithmeticOperators#getOperatorPriority(String)} INSTEAD!
2727
*/
2828
@Deprecated
2929
protected String[] priority1Oprs = {"*", "*-", "/", "/-", "%"}, priority2Oprs = {"**", "**-"};

‎SerialX-operators/src/main/java/org/ugp/serialx/converters/operators/ConditionalAssignmentOperators.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ public Object parse(ParserRegistry myHomeRegistry, String str, Object... args)
5858
/**
5959
* @param str | Source string to search.
6060
* @param defaultCountOfConfitions | How many condition operators (tenraryTokens[0]) are expected. Should be 1 in most cases.
61-
* @param tenraryTokens | Characters representing parts of ternary operator. Index 0 should be '?' and index 1 should be ':'.
61+
* @param ternaryOperators | Characters representing parts of ternary operator. Index 0 should be '?' and index 1 should be ':'.
6262
*
6363
* @return Return index of else branch in ternary operator expression or -1 if there is no else branch!
6464
*

‎pom.xml

Lines changed: 33 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,12 @@
4848
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
4949
<maven.compiler.source>${java.version}</maven.compiler.source>
5050
<maven.compiler.target>${java.version}</maven.compiler.target>
51+
52+
<project.build.finalName>serialx-${project.artifactId}-${project.version}</project.build.finalName>
5153
</properties>
5254

5355
<build>
54-
<finalName>serialx-${project.artifactId}-${project.version}</finalName>
56+
<finalName>${project.build.finalName}</finalName>
5557

5658
<plugins>
5759
<plugin>
@@ -78,6 +80,36 @@
7880
</dependency>
7981
</dependencies>
8082
</plugin>
83+
<plugin>
84+
<groupId>org.apache.maven.plugins</groupId>
85+
<artifactId>maven-javadoc-plugin</artifactId>
86+
<version>3.6.3</version>
87+
88+
<configuration>
89+
<additionalOptions>-Xdoclint:none</additionalOptions>
90+
<additionalJOption>-Xdoclint:none</additionalJOption>
91+
</configuration>
92+
93+
<executions>
94+
<execution>
95+
<goals>
96+
<goal>jar</goal>
97+
</goals>
98+
</execution>
99+
</executions>
100+
</plugin>
101+
<plugin>
102+
<groupId>org.apache.maven.plugins</groupId>
103+
<artifactId>maven-source-plugin</artifactId>
104+
<version>3.2.1</version>
105+
<executions>
106+
<execution>
107+
<goals>
108+
<goal>jar</goal>
109+
</goals>
110+
</execution>
111+
</executions>
112+
</plugin>
81113
</plugins>
82114
</build>
83115
</project>

0 commit comments

Comments
 (0)