Skip to content

Commit

Permalink
twy docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@AyhamAl-Ali
AyhamAl-Ali committed Mar 31, 2024
1 parent d43d932 commit 81970ae
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 11 deletions.
2 changes: 1 addition & 1 deletion src/main/java/ch/njol/skript/doc/Documentation.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -485,7 +485,7 @@ public static String escapeHTML(@Nullable String value) {
assert false;
return "";
}
return "" + value.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;");
return HTMLGenerator.introduceSkwipt("" + value.replace("&", "&amp;").replace("<", "&lt;").replace(">", "&gt;"));
}

public static String[] escapeHTML(@Nullable String[] values) {
Expand Down
31 changes: 21 additions & 10 deletions src/main/java/ch/njol/skript/doc/HTMLGenerator.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ private String generateAnnotated(String descTemp, SyntaxElementInfo<?> info, @Nu
desc = desc.replace("${element.since}", getDefaultIfNullOrEmpty((since != null ? since.value() : null), "Unknown"));

Keywords keywords = c.getAnnotation(Keywords.class);
desc = desc.replace("${element.keywords}", keywords == null ? "" : Joiner.on(", ").join(keywords.value()));
desc = desc.replace("${element.keywords}", keywords == null ? "" : introduceSkwipt(Joiner.on(", ").join(keywords.value())));

// Description
Description description = c.getAnnotation(Description.class);
Expand Down Expand Up @@ -493,7 +493,7 @@ private String generateAnnotated(String descTemp, SyntaxElementInfo<?> info, @Nu
}
desc = desc.replace("${element.events}", Joiner.on(", ").join(eventLinks));
}
desc = desc.replace("${element.events-safe}", events == null ? "" : Joiner.on(", ").join((events != null ? events.value() : null)));
desc = desc.replace("${element.events-safe}", events == null ? "" : introduceSkwipt(Joiner.on(", ").join((events != null ? events.value() : null))));

// RequiredPlugins
RequiredPlugins plugins = c.getAnnotation(RequiredPlugins.class);
Expand Down Expand Up @@ -523,10 +523,10 @@ private String generateAnnotated(String descTemp, SyntaxElementInfo<?> info, @Nu

// TODO add type of entrydata like boolean/string/section etc.
desc = handleIf(desc, "${if structure-optional-entrydata}", entryValidator != null);
desc = desc.replace("${element.structure-optional-entrydata}", entryValidator == null ? "" : Joiner.on(", ").join(entryDataList.stream().filter(EntryData::isOptional).map(EntryData::getKey).collect(Collectors.toList())));
desc = desc.replace("${element.structure-optional-entrydata}", entryValidator == null ? "" : introduceSkwipt(Joiner.on(", ").join(entryDataList.stream().filter(EntryData::isOptional).map(EntryData::getKey).collect(Collectors.toList()))));

desc = handleIf(desc, "${if structure-required-entrydata}", entryValidator != null);
desc = desc.replace("${element.structure-required-entrydata}", entryValidator == null ? "" : Joiner.on(", ").join(entryDataList.stream().filter(entryData -> !entryData.isOptional()).map(EntryData::getKey).collect(Collectors.toList())));
desc = desc.replace("${element.structure-required-entrydata}", entryValidator == null ? "" : introduceSkwipt(Joiner.on(", ").join(entryDataList.stream().filter(entryData -> !entryData.isOptional()).map(EntryData::getKey).collect(Collectors.toList()))));
} else {
desc = handleIf(desc, "${if structure-optional-entrydata}", false);
desc = handleIf(desc, "${if structure-required-entrydata}", false);
Expand Down Expand Up @@ -601,7 +601,7 @@ private String generateEvent(String descTemp, SkriptEventInfo<?> info, @Nullable
.replace("\\", "\\\\").replace("\"", "\\\"").replace("\t", " "));

String[] keywords = info.getKeywords();
desc = desc.replace("${element.keywords}", keywords == null ? "" : Joiner.on(", ").join(keywords));
desc = desc.replace("${element.keywords}", keywords == null ? "" : introduceSkwipt(Joiner.on(", ").join(keywords)));

// Documentation ID
String ID = info.getDocumentationID() != null ? info.getDocumentationID() : info.getId();
Expand All @@ -625,7 +625,7 @@ private String generateEvent(String descTemp, SkriptEventInfo<?> info, @Nullable
}
desc = desc.replace("${element.events}", Joiner.on(", ").join(eventLinks));
}
desc = desc.replace("${element.events-safe}", events == null ? "" : Joiner.on(", ").join((events != null ? events.value() : null)));
desc = desc.replace("${element.events-safe}", events == null ? "" : introduceSkwipt(Joiner.on(", ").join((events != null ? events.value() : null))));

// Required Plugins
String[] requiredPlugins = info.getRequiredPlugins();
Expand Down Expand Up @@ -707,7 +707,7 @@ private String generateClass(String descTemp, ClassInfo<?> info, @Nullable Strin
.replace("\\", "\\\\").replace("\"", "\\\"").replace("\t", " "));

Keywords keywords = c.getAnnotation(Keywords.class);
desc = desc.replace("${element.keywords}", keywords == null ? "" : Joiner.on(", ").join(keywords.value()));
desc = desc.replace("${element.keywords}", keywords == null ? "" : introduceSkwipt(Joiner.on(", ").join(keywords.value())));

// Documentation ID
String ID = info.getDocumentationID() != null ? info.getDocumentationID() : info.getCodeName();
Expand All @@ -731,10 +731,10 @@ private String generateClass(String descTemp, ClassInfo<?> info, @Nullable Strin
}
desc = desc.replace("${element.events}", Joiner.on(", ").join(eventLinks));
}
desc = desc.replace("${element.events-safe}", events == null ? "" : Joiner.on(", ").join((events != null ? events.value() : null)));
desc = desc.replace("${element.events-safe}", events == null ? "" : introduceSkwipt(Joiner.on(", ").join((events != null ? events.value() : null))));

// Required Plugins
String[] requiredPlugins = info.getRequiredPlugins();
String[] requiredPlugins = introduceSkwipt(info.getRequiredPlugins());
desc = handleIf(desc, "${if required-plugins}", requiredPlugins != null);
desc = desc.replace("${element.required-plugins}", Joiner.on(", ").join(requiredPlugins == null ? new String[0] : requiredPlugins));

Expand Down Expand Up @@ -912,7 +912,7 @@ public String getDefaultIfNullOrEmpty(@Nullable String string, String message) {
}

public String[] getDefaultIfNullOrEmpty(@Nullable String[] string, String message) {
return (string == null || string.length == 0 || string[0].equals("")) ? new String[]{ message } : string; // Null check first otherwise NullPointerException is thrown
return (string == null || string.length == 0 || "".equals(string[0]) ? new String[]{ introduceSkwipt(message) } : introduceSkwipt(string)); // Null check first otherwise NullPointerException is thrown
}

private String replaceReturnType(String desc, @Nullable ClassInfo<?> returnType) {
Expand All @@ -929,4 +929,15 @@ private String replaceReturnType(String desc, @Nullable ClassInfo<?> returnType)
return desc;
}

public static String introduceSkwipt(String string) {
return string.replace('r', 'w').replace('l', 'w').replace("this", "dat");
}

public static String[] introduceSkwipt(String[] string) {
for (int i = 0; i < string.length; i++) {
string[i] = introduceSkwipt(string[i]);
}
return string;
}

}

0 comments on commit 81970ae

Please sign in to comment.