Logs handling API - add javadoc
MODIFY
asciidoctorj-api/src/main/java/org/asciidoctor/ast/Cursor.java
asciidoctorj-api/src/main/java/org/asciidoctor/ast/Cursor.java
@@ -7,10 +7,19 @@ public interface Cursor {
*/
int getLineNumber();
+ /**
+ * @return Source file simple name, or <code>&lt;stdin&gt;</code> value when rending from a String.
+ */
String getPath();
+ /**
+ * @return Absolute path to the source file parent directory, or the execution path when rending from a String.
+ */
String getDir();
+ /**
+ * @return Absolute path to the source file, or <code>null</code> when rending from a String. These will point to the correct source file, even when it is included from another.
+ */
String getFile();
}

MODIFY
asciidoctorj-api/src/main/java/org/asciidoctor/log/LogRecord.java
asciidoctorj-api/src/main/java/org/asciidoctor/log/LogRecord.java
@@ -33,22 +33,37 @@ public class LogRecord {
this.sourceMethodName = sourceMethodName;
}
+ /**
+ * @return Severity level of the current record.
+ */
public Severity getSeverity() {
return severity;
}
+ /**
+ * @return Information about the location of the event
+ */
public Cursor getCursor() {
return cursor;
}
+ /**
+ * @return Descriptive message about the event.
+ */
public String getMessage() {
return message;
}
+ /**
+ * @return The value <code>&lt;script&gt;</code>. For the source filename use {@link Cursor#getFile()} obtained with the {@link #getCursor()} method.
+ */
public String getSourceFileName() {
return sourceFileName;
}
+ /**
+ * @return The Asciidoctor Ruby engine method used to render the file; <code>convertFile</code> or <code>convert</code> whether you are rending a File or a String.
+ */
public String getSourceMethodName() {
return sourceMethodName;
}

Logs handling API - add javadoc