From ca965765a69b96141ddf9cc170cb380eb21cf28e Mon Sep 17 00:00:00 2001 From: Kevin Lamonte Date: Fri, 28 Jul 2017 21:31:17 -0400 Subject: [PATCH] Update package comments --- docs/TODO.md | 19 ++++++++++++++++--- src/jexer/backend/package-info.java | 3 +-- src/jexer/bits/package-info.java | 4 ++-- src/jexer/event/package-info.java | 4 ++-- src/jexer/io/package-info.java | 3 +-- src/jexer/menu/package-info.java | 2 +- src/jexer/session/package-info.java | 3 +-- 7 files changed, 24 insertions(+), 14 deletions(-) diff --git a/docs/TODO.md b/docs/TODO.md index a3455e5..3f4df47 100644 --- a/docs/TODO.md +++ b/docs/TODO.md @@ -10,12 +10,25 @@ BUG: TTreeView.reflow() doesn't keep the vertical dot within the 0.0.5 +- TApplication + - getAllWindows() + - Expose menu management functions (addMenu, getMenu, getAllMenus, + removeMenu, ...) -- TWindow: - - UNCLOSABLE (#8) +- TEditor + - Swich Line from String to ArrayList + - StringUtils.justify functions for ArrayList + - TEditorWindow extends TScrollableWindow + - TEditor widget with keystroke functions: + - cursorRight/Left/... + - insertChar + - deleteForwardChar + - deleteBackwardChar + - deleteBackwardWord + - wordCount + - ... -- TEditor - Eliminate all Eclipse warnings 0.0.6 diff --git a/src/jexer/backend/package-info.java b/src/jexer/backend/package-info.java index 75d7818..dbaa6da 100644 --- a/src/jexer/backend/package-info.java +++ b/src/jexer/backend/package-info.java @@ -28,7 +28,6 @@ */ /** - * This package contains the Backend interface between TApplication and - * user-facing I/O. + * The interface between TApplication and user-facing I/O. */ package jexer.backend; diff --git a/src/jexer/bits/package-info.java b/src/jexer/bits/package-info.java index 280b140..f8531dd 100644 --- a/src/jexer/bits/package-info.java +++ b/src/jexer/bits/package-info.java @@ -28,7 +28,7 @@ */ /** - * This package contains low-level data objects and utility functions that - * don't warrant their own separate package. + * Low-level data objects and utility functions that don't warrant their own + * separate package. */ package jexer.bits; diff --git a/src/jexer/event/package-info.java b/src/jexer/event/package-info.java index 3c55ca1..dce2c90 100644 --- a/src/jexer/event/package-info.java +++ b/src/jexer/event/package-info.java @@ -28,7 +28,7 @@ */ /** - * This package contains the events that are generated by both end-user I/O - * (keyboard/mouse) and other UI elements (menu/resize). + * Events that are generated by both end-user I/O (keyboard/mouse) and other + * UI elements (menu/resize). */ package jexer.event; diff --git a/src/jexer/io/package-info.java b/src/jexer/io/package-info.java index 9b579da..04cbc59 100644 --- a/src/jexer/io/package-info.java +++ b/src/jexer/io/package-info.java @@ -28,7 +28,6 @@ */ /** - * This package contains the user-facing I/O, including screen, keyboard, and - * mouse handling classes. + * User-facing I/O, including screen, keyboard, and mouse handling classes. */ package jexer.io; diff --git a/src/jexer/menu/package-info.java b/src/jexer/menu/package-info.java index 0ef86c0..6781106 100644 --- a/src/jexer/menu/package-info.java +++ b/src/jexer/menu/package-info.java @@ -28,6 +28,6 @@ */ /** - * This package contains the menu bar classes. + * Menu bar support classes. */ package jexer.menu; diff --git a/src/jexer/session/package-info.java b/src/jexer/session/package-info.java index b7dacc4..0b6ccf0 100644 --- a/src/jexer/session/package-info.java +++ b/src/jexer/session/package-info.java @@ -28,7 +28,6 @@ */ /** - * This package contains classes to encapsulate text terminal metadata: - * width, height, username, language, etc. + * Text terminal session values: width, height, username, language, etc. */ package jexer.session; -- 2.27.0