summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKurt Hindenburg <[email protected]>2018-01-13 12:22:32 -0500
committerKurt Hindenburg <[email protected]>2018-01-13 12:22:32 -0500
commitb6fb10ff733940b625ef97c4bef1504a45961486 (patch)
tree8ac730628c89241c03a851df73e74d474d635584
parent7693106396c9fbe62c3b20a0709bda5f88e58929 (diff)
fix some parameter/api documentation mismatches
-rw-r--r--src/Screen.h34
-rw-r--r--src/ScreenWindow.h5
-rw-r--r--src/Session.h2
-rw-r--r--src/TerminalDisplay.h4
4 files changed, 17 insertions, 28 deletions
diff --git a/src/Screen.h b/src/Screen.h
index 570f04f..868508f 100644
--- a/src/Screen.h
+++ b/src/Screen.h
@@ -73,6 +73,15 @@ class HistoryScroll;
class Screen
{
public:
+ /* PlainText: Return plain text (default)
+ * ConvertToHtml: Specifies if returned text should have HTML tags.
+ * PreserveLineBreaks: Specifies whether new line characters should be
+ * inserted into the returned text at the end of each terminal line.
+ * TrimLeadingWhitespace: Specifies whether leading spaces should be
+ * trimmed in the returned text.
+ * TrimTrailingWhitespace: Specifies whether trailing spaces should be
+ * trimmed in the returned text.
+ */
enum DecodingOption {
PlainText = 0x0,
ConvertToHtml = 0x1,
@@ -411,7 +420,7 @@ public:
/**
* Sets the start of the selection.
*
- * @param xThe column index of the first character in the selection.
+ * @param x The column index of the first character in the selection.
* @param y The line index of the first character in the selection.
* @param blockSelectionMode True if the selection is in column mode.
*/
@@ -448,13 +457,7 @@ public:
/**
* Convenience method. Returns the currently selected text.
- * @param preserveLineBreaks Specifies whether new line characters should
- * be inserted into the returned text at the end of each terminal line.
- * @param trimTrailingSpaces Specifies whether trailing spaces should be
- * trimmed in the returned text.
- * @param trimLeadingSpaces Specifies whether leading spaces should be
- * trimmed in the returned text.
- * @param html Specifies if returned text should have HTML tags.
+ * @param options See Screen::DecodingOptions
*/
QString selectedText(const DecodingOptions options) const;
@@ -462,13 +465,7 @@ public:
* Convenience method. Returns the text between two indices.
* @param startIndex Specifies the starting text index
* @param endIndex Specifies the ending text index
- * @param preserveLineBreaks Specifies whether new line characters should
- * be inserted into the returned text at the end of each terminal line.
- * @param trimTrailingSpaces Specifies whether trailing spaces should be
- * trimmed in the returned text.
- * @param trimLeadingSpaces Specifies whether leading spaces should be
- * trimmed in the returned text.
- * @param html Specifies if returned text should have HTML tags.
+ * @param options See Screen::DecodingOptions
*/
QString text(int startIndex, int endIndex, const DecodingOptions options) const;
@@ -488,12 +485,7 @@ public:
* @param decoder A decoder which converts terminal characters into text.
* PlainTextDecoder is the most commonly used decoder which converts characters
* into plain text with no formatting.
- * @param preserveLineBreaks Specifies whether new line characters should
- * be inserted into the returned text at the end of each terminal line.
- * @param trimTrailingSpaces Specifies whether trailing spaces should be
- * trimmed in the returned text.
- * @param trimLeadingSpaces Specifies whether leading spaces should be
- * trimmed in the returned text.
+ * @param options See Screen::DecodingOptions
*/
void writeSelectionToStream(TerminalCharacterDecoder *decoder, const Konsole::Screen::DecodingOptions options) const;
diff --git a/src/ScreenWindow.h b/src/ScreenWindow.h
index 640f828..38c0b01 100644
--- a/src/ScreenWindow.h
+++ b/src/ScreenWindow.h
@@ -227,10 +227,7 @@ public:
/**
* Returns the text which is currently selected.
*
- * @param preserveLineBreaks See Screen::selectedText()
- * @param trimTrailingSpaces See Screen::selectedText()
- * @param trimLeadingSpaces See Screen::selectedText()
- * @param html Specifies if returned text should have HTML tags.
+ * @param options See Screen::DecodingOptions
*/
QString selectedText(const Konsole::Screen::DecodingOptions options) const;
diff --git a/src/Session.h b/src/Session.h
index 3cf8134..1b8ea7d 100644
--- a/src/Session.h
+++ b/src/Session.h
@@ -95,7 +95,7 @@ public:
*
* Calling openTeletype() while a session is running has no effect.
*
- * @param masterFd The file descriptor of the pseudo-teletype master (See KPtyProcess::KPtyProcess())
+ * @param fd The file descriptor of the pseudo-teletype master (See KPtyProcess::KPtyProcess())
*/
void openTeletype(int fd);
diff --git a/src/TerminalDisplay.h b/src/TerminalDisplay.h
index 06c7728..cf0db82 100644
--- a/src/TerminalDisplay.h
+++ b/src/TerminalDisplay.h
@@ -104,7 +104,7 @@ public:
* Sets the current position and range of the display's scroll bar.
*
* @param cursor The position of the scroll bar's thumb.
- * @param lines The maximum value of the scroll bar.
+ * @param slines The maximum value of the scroll bar.
*/
void setScroll(int cursor, int slines);
@@ -614,7 +614,7 @@ public Q_SLOTS:
* view area - since the program running in the terminal is being allowed to handle normal mouse
* events itself.
*
- * @param usesMouse Set to true if the program running in the terminal is interested in mouse events
+ * @param on Set to true if the program running in the terminal is interested in mouse events
* or false otherwise.
*/
void setUsesMouse(bool on);