diff --git a/src/ColorScheme.h b/src/ColorScheme.h index 509e2160..e3112d93 100644 --- a/src/ColorScheme.h +++ b/src/ColorScheme.h @@ -113,9 +113,9 @@ public: bool hasDarkBackground() const; /** - * Sets the opacity level of the display background. A value of - * 0 represents a completely transparent background, up to a value of 1 - * representing a completely opaque background. + * Sets the opacity level of the display background. @p opacity ranges + * between 0 (completely transparent background) and 1 (completely + * opaque background). * * Defaults to 1. * diff --git a/src/Profile.h b/src/Profile.h index df33fd5d..d2709769 100644 --- a/src/Profile.h +++ b/src/Profile.h @@ -86,7 +86,7 @@ public: */ Environment, /** (QString) The initial working directory for sessions created using this profile. */ - Directory, // QString + Directory, /** (QString) The format used for tab titles when running normal commands. */ LocalTabTitleFormat, @@ -127,6 +127,7 @@ public: ScrollBarPosition, /** TODO Document me*/ + // FIXME - Is this a duplicate of WordCharacters? SelectWordCharacters, /** (bool) Specifies whether text in terminal displays is allowed to blink. */ BlinkingTextEnabled, @@ -141,7 +142,7 @@ public: /** (bool) Specifies whether the cursor blinks ( in a manner similar * to text editing applications ) */ - BlinkingCursorEnabled, // bool + BlinkingCursorEnabled, /** (bool) If true, terminal displays use a fixed color to draw the cursor, * specified by the CustomCursorColor property. Otherwise the cursor changes @@ -154,9 +155,11 @@ public: * if the UseCustomCursorColor property is true. */ CustomCursorColor, - /** TODO Document me */ + /** (QString) A string consisting of the characters used to delimit words when + * selecting text in the terminal display. + */ // FIXME - Is this a duplicate of SelectWordCharacters? - WordCharacters, // QString + WordCharacters, /** (TabBarPositionEnum) Position of the tab-bar relative to the terminal displays. */ TabBarPosition, @@ -392,9 +395,8 @@ public: * Returns true if the profile was successfully read or false otherwise. * * @param path Path to the profile to read - * @param profile TODO: Document me + * @param profile Pointer to the Profile the settings will be read into * @param parentProfile Receives the name of the parent profile specified in - * @p path. TODO: Document me */ virtual bool readProfile(const QString& path , Profile* profile , QString& parentProfile) = 0; }; diff --git a/src/Pty.h b/src/Pty.h index 16ae8f8a..6a0766e2 100644 --- a/src/Pty.h +++ b/src/Pty.h @@ -125,7 +125,10 @@ Q_OBJECT */ int foregroundProcessGroup() const; - /** TODO: Document me */ + /** + * Returns whether the buffer used to send data to the + * terminal process is full. + */ bool bufferFull() const { return _bufferFull; } public slots: @@ -174,7 +177,8 @@ Q_OBJECT void receivedData(const char* buffer, int length); /** - * TODO: Document me + * Emitted when the buffer used to send data to the terminal + * process becomes empty, i.e. all data has been sent. */ void bufferEmpty(); diff --git a/src/Screen.h b/src/Screen.h index 22f784c5..9fe0336f 100644 --- a/src/Screen.h +++ b/src/Screen.h @@ -222,10 +222,9 @@ public: // these are all `Screen' operations /** * Sets the start of the selection. * - * @param cursor TODO: Document me * @param column The column index of the first character in the selection. * @param line The line index of the first character in the selection. - * @param columnmode TODO: Document me + * @param columnmode True if the selection is in column mode. */ void setSelectionStart(const int column, const int line, const bool columnmode); @@ -254,13 +253,7 @@ public: // these are all `Screen' operations void setBusySelecting(bool busy) { sel_busy = busy; } - /** - * Returns true if the character at (@p column, @p line) is part of the current selection. - * - * @param cursor TODO: Document me - * @param column TODO: Document me - * @param line TODO: Document me - */ + /** Returns true if the character at (@p column, @p line) is part of the current selection. */ bool isSelected(const int column,const int line); /** diff --git a/src/Session.h b/src/Session.h index 438b7cc1..86c2424f 100644 --- a/src/Session.h +++ b/src/Session.h @@ -132,11 +132,14 @@ public: Emulation* emulation() const; /** - * TODO: Document me + * Returns the environment of this session as a list of strings like + * VARIABLE=VALUE */ QStringList environment() const; /** - * TODO: Document me + * Sets the environment for this session. + * @p environment should be a list of strings like + * VARIABLE=VALUE */ void setEnvironment(const QStringList& environment); @@ -279,18 +282,21 @@ public: /** Returns the name of the icon associated with this session. */ QString iconName() const; - /** TODO: Document me */ + /** Sets the text of the icon associated with this session. */ void setIconText(const QString& iconText); - /** TODO: Document me */ + /** Returns the text of the icon associated with this session. */ QString iconText() const; - /** TODO: Document me */ + /** Specifies whether a utmp entry should be created for the pty used by this session. */ void setAddToUtmp(bool); /** Sends the specified @p signal to the terminal process. */ bool sendSignal(int signal); - /** TODO: Document me */ + /** + * Specifies whether to close the session automatically when the terminal + * process terminates. + */ void setAutoClose(bool b) { _autoClose = b; } /** @@ -372,7 +378,11 @@ public slots: */ void close(); - /** TODO: Document me */ + /** + * Changes the session title or other customizable aspects of the terminal + * emulation display. For a list of what may be changed see the + * Emulation::titleChanged() signal. + */ void setUserTitle( int, const QString &caption ); signals: diff --git a/src/TerminalDisplay.h b/src/TerminalDisplay.h index 2aef01bd..8647454d 100644 --- a/src/TerminalDisplay.h +++ b/src/TerminalDisplay.h @@ -75,9 +75,15 @@ public: const ColorEntry* colorTable() const; /** Sets the terminal color palette used by the display. */ void setColorTable(const ColorEntry table[]); - /** TODO: Document me */ + /** + * Sets the seed used to generate random colors for the display + * (in color schemes that support them). + */ void setRandomSeed(uint seed); - /** TODO: Document me */ + /** + * Returns the seed used to generate random colors for the display + * (in color schemes that support them). + */ uint randomSeed() const; /** Sets the opacity of the terminal display. */ diff --git a/src/ViewManager.h b/src/ViewManager.h index 8ab6a048..25a7f6bc 100644 --- a/src/ViewManager.h +++ b/src/ViewManager.h @@ -161,7 +161,10 @@ signals: // 'multipleViews' - true if the manager has multiple containers or false otherwise void splitViewToggle(bool multipleViews); - /** TODO: Document me. */ + /** + * Emitted when menu bar visibility changes because a profile that requires so is + * activated. + */ void setMenuBarVisible(bool); private slots: