diff options
author | Aaron Gyes <me@aaron.gy> | 2016-06-05 21:42:01 -0700 |
---|---|---|
committer | Aaron Gyes <me@aaron.gy> | 2016-06-05 21:42:01 -0700 |
commit | 7ef40f4e53827e9e2c429230f5fadbd093cd6402 (patch) | |
tree | 40f7cdc623615302ba40ee5e0dfa57c3994dada8 /src/reader.cpp | |
parent | 9f21e3792aed2ac0c9bbbc94d3e4ff169cc0288a (diff) | |
parent | 2fafb13eaa30981754a8cd0ba8f3c082e3147fa8 (diff) |
Merge pull request #3118 from floam/headerdoc-fixes
Update Xcode project, HeaderDoc comments.
Fix various invalid HeaderDoc comments. Normalize autoload.cpp/autoload.h as an example of something closer to "proper" HeaderDoc formatting.
Have clang/Xcode validate HeaderDoc comments. Remove key_reader.cpp from Xcode project.
Diffstat (limited to 'src/reader.cpp')
-rw-r--r-- | src/reader.cpp | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/src/reader.cpp b/src/reader.cpp index 968a508a..2d6a6bb8 100644 --- a/src/reader.cpp +++ b/src/reader.cpp @@ -1827,14 +1827,15 @@ static void handle_token_history(int forward, int reset) { } } + +enum move_word_dir_t { MOVE_DIR_LEFT, MOVE_DIR_RIGHT }; + /// Move buffer position one word or erase one word. This function updates both the internal buffer /// and the screen. It is used by M-left, M-right and ^W to do block movement or block erase. /// -/// \param dir Direction to move/erase. 0 means move left, 1 means move right. +/// \param move_right true if moving right /// \param erase Whether to erase the characters along the way or only move past them. -/// \param new if the new kill item should be appended to the previous kill item or not. -enum move_word_dir_t { MOVE_DIR_LEFT, MOVE_DIR_RIGHT }; - +/// \param newv if the new kill item should be appended to the previous kill item or not. static void move_word(editable_line_t *el, bool move_right, bool erase, enum move_word_style_t style, bool newv) { // Return if we are already at the edge. @@ -2171,11 +2172,9 @@ static int threaded_highlight(background_highlight_context_t *ctx) { /// highlighting maykes characters under the sursor unreadable. /// /// \param match_highlight_pos_adjust the adjustment to the position to use for bracket matching. -/// This is added to the current cursor position and may be negative. -/// \param error if non-null, any possible errors in the buffer are further descibed by the strings -/// inserted into the specified arraylist +/// This is added to the current cursor position and may be negative. /// \param no_io if true, do a highlight that does not perform I/O, synchronously. If false, perform -/// an asynchronous highlight in the background, which may perform disk I/O. +/// an asynchronous highlight in the background, which may perform disk I/O. static void reader_super_highlight_me_plenty(int match_highlight_pos_adjust, bool no_io) { const editable_line_t *el = &data->command_line; long match_highlight_pos = (long)el->position + match_highlight_pos_adjust; |