Skip to content
This repository has been archived by the owner on Aug 12, 2022. It is now read-only.

Make single line multi-line documentation #50

Merged
merged 1 commit into from
May 16, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 33 additions & 11 deletions AcornUiCore/src/com/acornui/file/FileIoManager.kt
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@ import com.acornui.io.NativeBuffer
*/
interface FileIoManager : Disposable {

/** If false, [pickFileForSave] will fail. */
/**
* If false, [pickFileForSave] will fail.
*/
val saveSupported: Boolean

/**
Expand Down Expand Up @@ -81,16 +83,26 @@ class FileFilterGroup(
*/
interface FileReader {

/** Name of the file including aboslute path (JS excludes path for security purposes) */
/**
* Name of the file including aboslute path (JS excludes path for security purposes)
*/
val name: String
/** Size of the file in bytes */
/**
* Size of the file in bytes
*/
val size: Long
/** Last date the file was modified as the number of milliseconds since the Unix Epoch */
/**
* Last date the file was modified as the number of milliseconds since the Unix Epoch
*/
val lastModified: Long

/** Read file ([name]) from disk as a String */
/**
* Read file ([name]) from disk as a String
*/
suspend fun readAsString(): String
/** Read file ([name]) from disk binary */
/**
* Read file ([name]) from disk binary
*/
suspend fun readAsBinary(): NativeBuffer<Byte>
}

Expand All @@ -101,15 +113,25 @@ interface FileReader {
*/
interface FileWriter {

/** Name of the file including absolute path */
/**
* Name of the file including absolute path
*/
val name: String
/** Size of the file in bytes */
/**
* Size of the file in bytes
*/
val size: Long
/** Last date the file was modified as the number of milliseconds since the Unix Epoch */
/**
* Last date the file was modified as the number of milliseconds since the Unix Epoch
*/
val lastModified: Long

/** Write file ([name]) to disk as a String */
/**
* Write file ([name]) to disk as a String
*/
suspend fun saveToFileAsString(value: String)
/** Write file ([name]) to disk as binary */
/**
* Write file ([name]) to disk as binary
*/
suspend fun saveToFileAsBinary(value: NativeBuffer<Byte>)
}