Skip to content

Commit

Permalink
fix links and escape special characters
Browse files Browse the repository at this point in the history
  • Loading branch information
zspitzer committed Jul 7, 2024
1 parent aece9db commit 8bf837b
Show file tree
Hide file tree
Showing 68 changed files with 124 additions and 182 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public ResourceDataSource(Resource res) {
/**
* Get name.
*
* @returns Name
* @return Name of resource
*/
@Override
public String getName() {
Expand All @@ -60,7 +60,7 @@ public String getName() {
/**
* Get Resource.
*
* @returns Resource
* @return Resource
*/
public Resource getResource() {
return _file;
Expand All @@ -69,7 +69,7 @@ public Resource getResource() {
/**
* Get input stream.
*
* @returns Input stream
* @return Input stream
* @throws IOException IO exception occurred
*/
@Override
Expand All @@ -80,7 +80,7 @@ public InputStream getInputStream() throws IOException {
/**
* Get content type.
*
* @returns Content type
* @return Content type
*/
@Override
public String getContentType() {
Expand All @@ -90,7 +90,7 @@ public String getContentType() {
/**
* Get output stream.
*
* @returns Output stream
* @return Output stream
* @throws IOException IO exception occurred
*/
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,15 +117,15 @@ public boolean contains(Object o) {
* <p>
* This method is equivalent to:
*
* <pre>
* <code>
* {
* &#64;code
* List<E> list = new ArrayList<E>(size());
* List&lt;E&gt; list = new ArrayList&lt;E&gt;(size());
* for (E e: this)
* list.add(e);
* return list.toArray();
* }
* </pre>
* </code>
*/
@Override
public Object[] toArray() {
Expand Down Expand Up @@ -159,7 +159,7 @@ public Object[] toArray() {
* <pre>
* {
* &#64;code
* List<E> list = new ArrayList<E>(size());
* List&lt;E&gt; list = new ArrayList&lt;E&gt;(size());
* for (E e: this)
* list.add(e);
* return list.toArray(a);
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/lucee/commons/lang/ParserString.java
Original file line number Diff line number Diff line change
Expand Up @@ -315,7 +315,7 @@ public boolean isPreviousPreviousWhiteSpace() {
}

/**
* Gibt zurueck ob das aktuelle Zeichen ein Special Buchstabe ist (_,<euro>,$,<pound>).
* Gibt zurueck ob das aktuelle Zeichen ein Special Buchstabe ist (_,&euro;,$,&pound;).
*
* @return Gibt zurueck ob das aktuelle Zeichen ein Buchstabe ist.
*/
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/lucee/runtime/crypt/Cryptor.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
import lucee.runtime.op.Caster;

/**
*
* Cryptor
*/
public class Cryptor {

Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/lucee/runtime/db/QoQ.java
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@
import lucee.runtime.util.DBUtilImpl;

/**
*
* Query of Queries (QoQ)
*/
public final class QoQ {
final static private Collection.Key paramKey = new KeyImpl("?");
Expand Down
10 changes: 6 additions & 4 deletions core/src/main/java/lucee/runtime/engine/InfoImpl.java
Original file line number Diff line number Diff line change
Expand Up @@ -305,16 +305,18 @@ public List<ExtensionDefintion> getRequiredExtension() {
return requiredExtensions;
}

/**
/*
* *
* @return returns the state
*
* @Override public int getStateAsInt() { return state; }
* Override public int getStateAsInt() { return state; }
*/

/**
/*
* *
* @return returns the state
*
* @Override public String getStateAsString() { return strState; }
* Override public String getStateAsString() { return strState; }
*/

/*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,14 @@
xorOp = orOp {"xor" spaces orOp};
orOp = andOp {("or" | "||") spaces andOp};
(* "||" Existiert in CFMX nicht *)
andOp = notOp {("and" | "&&") spaces notOp};
(* "&&" Existiert in CFMX nicht *)
andOp = notOp {("and" | "&amp;&amp;") spaces notOp};
(* "&amp;&amp;" Existiert in CFMX nicht *)
notOp = [("not"|"!") spaces] decsionOp;
(* "!" Existiert in CFMX nicht *)
decsionOp = concatOp {("neq"|"eq"|"gte"|"gt"|"lte"|"lt"|"ct"|
"contains"|"nct"|"does not contain") spaces concatOp};
(* "ct"=conatains und "nct"=does not contain; Existiert in CFMX nicht *)
concatOp = plusMinusOp {"&" spaces plusMinusOp};
concatOp = plusMinusOp {"&amp;" spaces plusMinusOp};
plusMinusOp = modOp {("-"|"+") spaces modOp};
modOp = divMultiOp {("mod" | "%") spaces divMultiOp};
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/lucee/runtime/net/ftp/AFTPClient.java
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ public static AFTPClient getInstance(String secure, InetAddress host, int port,
* NOT close the given OutputStream. If the current file type is ASCII, line separators in the file
* are converted to the local representation.
* <p>
* Note: if you have used {@link #setRestartOffset(long)}, the file data will start from the
* Note: if you have used setRestartOffset(long), the file data will start from the
* selected offset.
*
* @param remote The name of the remote file.
Expand Down Expand Up @@ -327,7 +327,7 @@ public static AFTPClient getInstance(String secure, InetAddress host, int port,

/**
* Opens a Socket connected to a remote host at the specified port and originating from the current
* host at a system assigned port. Before returning, {@link #_connectAction_ _connectAction_() } is
* host at a system assigned port. Before returning, connectAction is
* called to perform connection initialization actions.
* <p>
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
package lucee.runtime.net.ftp;

/**
*
* Creates a FTP Connection
*/
public final class FTPConnectionImpl implements FTPConnection {

Expand Down
1 change: 0 additions & 1 deletion core/src/main/java/lucee/runtime/op/Caster.java
Original file line number Diff line number Diff line change
Expand Up @@ -3301,7 +3301,6 @@ public static QueryColumn toQueryColumn(Object o, QueryColumn defaultValue) {
* @param pc
* @return
* @throws PageException
* @info used in bytecode generation
*/
public static QueryColumn toQueryColumn(Object o, PageContext pc) throws PageException {
if (o instanceof QueryColumn) return (QueryColumn) o;
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/lucee/runtime/osgi/BundleInfo.java
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ public Object info() {
}

/**
* Value can be a string (for a Single entry or a List<String> for multiple entries)
* Value can be a string (for a Single entry or a List&lt;String&gt; for multiple entries)
*
* @return
*/
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/lucee/runtime/osgi/OSGiUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -2199,7 +2199,7 @@ public static String toState(int state, String defaultValue) {
}

/**
* value can be a String (for a single entry) or a List<String> for multiple entries
* value can be a String (for a single entry) or a List&lt;String&gt; for multiple entries
*
* @param b
* @return
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ public SpoolerTaskHTTPCall(ExecutionPlan[] plans, RemoteClient client) {

/**
* @return
* @see lucee.runtime.spooler.SpoolerTask#execute()
* @see lucee.runtime.spooler.SpoolerTask#execute(Config)
*/
@Override
public final Object execute(Config config) throws PageException {
Expand Down
1 change: 0 additions & 1 deletion core/src/main/java/lucee/runtime/tag/Execute.java
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,6 @@ public void setErrorvariable(String errorVariable) throws PageException {
* the output is displayed on the page from which it was called.
*
* @param outputfile value to set
* @throws SecurityException
**/
public void setOutputfile(String outputfile) {
try {
Expand Down
5 changes: 5 additions & 0 deletions core/src/main/java/lucee/runtime/tag/_Execute.java
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@
import lucee.commons.lang.PageContextThread;
import lucee.runtime.PageContext;

/*
* Execute external processes
*/
public final class _Execute extends PageContextThread {

private Resource outputfile;
Expand All @@ -45,6 +48,8 @@ public final class _Execute extends PageContextThread {
private String directory;

/**
* Constructor: Execute external processes
*
* @param pageContext
* @param monitor
* @param commands
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/lucee/runtime/text/xml/XMLUtil.java
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@
import lucee.runtime.type.util.StructUtil;

/**
*
* Utils for XML
*/
public final class XMLUtil {

Expand Down
3 changes: 0 additions & 3 deletions core/src/main/java/lucee/runtime/type/QueryImpl.java
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,6 @@
/**
* implementation of the query interface
*/
/**
*
*/
public class QueryImpl implements Query, Objects, QueryResult {

private static final long serialVersionUID = 1035795427320192551L; // do not chnage
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/lucee/runtime/type/StructImplKey.java
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ public void clear() {

/**
*
* @see lucee.runtime.dump.Dumpable#toDumpData(lucee.runtime.PageContext, int)
* @see lucee.runtime.dump.Dumpable#toDumpData(lucee.runtime.PageContext, int, DumpProperties)
*/
@Override
public DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties dp) {
Expand Down Expand Up @@ -238,7 +238,7 @@ public Iterator<Entry<Key, Object>> entryIterator() {
}

/**
* @see lucee.runtime.type.Iteratorable#iterator()
* @see lucee.runtime.type.Iteratorable#valueIterator()
*/
@Override
public Iterator valueIterator() {
Expand Down Expand Up @@ -320,7 +320,7 @@ public DateTime castToDateTime(DateTime defaultValue) {
}

/**
* @see lucee.runtime.op.Castable#compare(boolean)
* @see lucee.runtime.op.Castable#compareTo(boolean)
*/
@Override
public int compareTo(boolean b) throws ExpressionException {
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/lucee/runtime/type/StructImplString.java
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ public void clear() {

/**
*
* @see lucee.runtime.dump.Dumpable#toDumpData(lucee.runtime.PageContext, int)
* @see lucee.runtime.dump.Dumpable#toDumpData(lucee.runtime.PageContext, int, DumpProperties)
*/
@Override
public DumpData toDumpData(PageContext pageContext, int maxlevel, DumpProperties dp) {
Expand Down Expand Up @@ -211,7 +211,7 @@ public Iterator<Collection.Key> keyIterator() {
}

/**
* @see lucee.runtime.type.Iteratorable#iterator()
* @see lucee.runtime.type.Iteratorable#valueIterator()
*/
@Override
public Iterator valueIterator() {
Expand Down Expand Up @@ -293,7 +293,7 @@ public DateTime castToDateTime(DateTime defaultValue) {
}

/**
* @see lucee.runtime.op.Castable#compare(boolean)
* @see lucee.runtime.op.Castable#compareTo(boolean)
*/
@Override
public int compareTo(boolean b) throws ExpressionException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ protected ExpressionException invalidKey(String key) {
}

/**
* write parameter defined in a query string (name1=value1&name2=value2) to the scope
* write parameter defined in a query string (name1=value1&amp;name2=value2) to the scope
*
* @param str Query String
* @return parsed name value pair
Expand Down
6 changes: 3 additions & 3 deletions core/src/main/java/lucee/runtime/type/sql/ClobImpl.java
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@
* the data itself. A <code>Clob</code> object is valid for the duration of the transaction in which
* is was created.
* <p>
* Methods in the interfaces {@link DriverResultSet},{@link CallableStatement}, and
* {@link PreparedStatement}, such as <code>getClob</code> and <code>setClob</code> allow a
* Methods in the interfaces DriverResultSet,{@link java.sql.CallableStatement}, and
* {@link java.sql.PreparedStatement}, such as <code>getClob</code> and <code>setClob</code> allow a
* programmer to access an SQL <code>CLOB</code> value. The <code>Clob</code> interface provides
* methods for getting the length of an SQL <code>CLOB</code> (Character Large Object) value, for
* materializing a <code>CLOB</code> value on the client, and for determining the position of a
Expand Down Expand Up @@ -117,7 +117,7 @@ public java.io.InputStream getAsciiStream() throws SQLException {
}

/**
* Materializes the <code>CLOB</code> value designated by this <code>object
* Materializes the <code>CLOB</code> value designated by this <code>object</code>
* as a stream of Unicode character.
*
* &#64;return A reader object with all the data in the <code>CLOB</code> value designated by this
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/lucee/runtime/util/HTTPUtilImpl.java
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ public URL toURL(String strUrl, int port, boolean encodeIfNecessary) throws Malf
}

/**
* @see lucee.commons.net.HTTPUtil#toURL(java.lang.String)
* @see lucee.commons.net.HTTPUtil#toURL(java.lang.String, short)
*/
@Override
public URL toURL(String strUrl) throws MalformedURLException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,11 @@

public class VideoExecuterNotSupported implements VideoExecuter {

/**
* @see lucee.runtime.video.VideoExecuter#convertRaw(lucee.runtime.config.ConfigWeb,
* lucee.runtime.video.VideoInput[], lucee.runtime.video.VideoOutput,
* lucee.runtime.video.VideoProfile)
*/
@Override
public VideoInfo[] convert(ConfigWeb config, VideoInput[] inputs, VideoOutput output, VideoProfile quality) throws IOException {
throw notSupported();
}

/**
* @see lucee.runtime.video.VideoExecuter#infoRaw(lucee.runtime.config.ConfigWeb,
* lucee.runtime.video.VideoInput)
*/
@Override
public VideoInfo info(ConfigWeb config, VideoInput input) throws IOException {
throw notSupported();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ public static ExprBoolean toExprBoolean(Expression expr) {
}

/**
* @see lucee.transformer.expression.Expression#writeOut(org.objectweb.asm.commons.GeneratorAdapter,
* int)
* @see lucee.transformer.expression.Expression#writeOut(lucee.transformer.Context,int)
*
*/
@Override
public Type _writeOut(BytecodeContext bc, int mode) throws TransformerException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ public static ExprInt toExprInt(Expression expr) {
}

/**
* @see lucee.transformer.expression.Expression#_writeOut(org.objectweb.asm.commons.GeneratorAdapter,
* int)
* @see lucee.transformer.expression.Expression#writeOut(BytecodeContext,int)
*
*/
@Override
public Type _writeOut(BytecodeContext bc, int mode) throws TransformerException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public static ExprNumber toExprNumber(Expression expr) {
}

/**
* @see lucee.transformer.expression.Expression#_writeOut(org.objectweb.asm.commons.GeneratorAdapter,
* lucee.transformer.expression.Expression#_writeOut(lucee.transformer.bytecode.BytecodeContext,
* int)
*/
@Override
Expand Down
Loading

0 comments on commit 8bf837b

Please sign in to comment.