From 1357f5a3647aba1024afe8557695c1a07a81b129 Mon Sep 17 00:00:00 2001 From: Aaron Gyes Date: Sun, 5 Jun 2016 18:46:04 -0700 Subject: Repair various invalid HeaderDoc comments. Enable build setting to allow Xcode to complain about invalid comments. --- fish.xcodeproj/project.pbxproj | 9 +++++++++ src/complete.cpp | 5 ++--- src/complete.h | 25 +++++++++++++------------ src/exec.cpp | 2 +- src/expand.h | 8 ++++---- src/highlight.h | 4 ++-- src/pager.cpp | 4 ++-- src/parse_util.h | 2 +- src/parser.h | 9 --------- src/postfork.cpp | 2 +- src/reader.cpp | 15 +++++++-------- src/screen.h | 2 +- 12 files changed, 43 insertions(+), 44 deletions(-) diff --git a/fish.xcodeproj/project.pbxproj b/fish.xcodeproj/project.pbxproj index 21cd62e4..4234a516 100644 --- a/fish.xcodeproj/project.pbxproj +++ b/fish.xcodeproj/project.pbxproj @@ -1547,6 +1547,8 @@ ALWAYS_SEARCH_USER_PATHS = NO; CLANG_CXX_LANGUAGE_STANDARD = "c++0x"; CLANG_CXX_LIBRARY = "libc++"; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_NULLABLE_TO_NONNULL_CONVERSION = YES; DEAD_CODE_STRIPPING = YES; DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; GCC_ENABLE_CPP_EXCEPTIONS = NO; @@ -1560,6 +1562,7 @@ "DOCDIR=L\\\"/usr/local/share/doc\\\"", ); GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_MISSING_NEWLINE = YES; GCC_WARN_ABOUT_RETURN_TYPE = YES; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_LABEL = YES; @@ -1762,6 +1765,8 @@ isa = XCBuildConfiguration; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_NULLABLE_TO_NONNULL_CONVERSION = YES; DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; GCC_ENABLE_CPP_EXCEPTIONS = NO; GCC_ENABLE_CPP_RTTI = YES; @@ -1776,6 +1781,7 @@ ); GCC_SYMBOLS_PRIVATE_EXTERN = NO; GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_MISSING_NEWLINE = YES; GCC_WARN_ABOUT_RETURN_TYPE = YES; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_LABEL = YES; @@ -1795,6 +1801,8 @@ isa = XCBuildConfiguration; buildSettings = { ALWAYS_SEARCH_USER_PATHS = NO; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_NULLABLE_TO_NONNULL_CONVERSION = YES; DEAD_CODE_STRIPPING = YES; DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; GCC_ENABLE_CPP_EXCEPTIONS = NO; @@ -1808,6 +1816,7 @@ "DOCDIR=L\\\"/usr/local/share/doc\\\"", ); GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_MISSING_NEWLINE = YES; GCC_WARN_ABOUT_RETURN_TYPE = YES; GCC_WARN_UNUSED_FUNCTION = YES; GCC_WARN_UNUSED_LABEL = YES; diff --git a/src/complete.cpp b/src/complete.cpp index f686ab31..e23e9ce1 100644 --- a/src/complete.cpp +++ b/src/complete.cpp @@ -652,8 +652,7 @@ static wcstring complete_function_desc(const wcstring &fn) { /// Complete the specified command name. Search for executables in the path, executables defined /// using an absolute path, functions, builtins and directories for implicit cd commands. /// -/// \param cmd the command string to find completions for -/// \param comp the list to add all completions to +/// \param str_cmd the command string to find completions for void completer_t::complete_cmd(const wcstring &str_cmd, bool use_function, bool use_builtin, bool use_command, bool use_implicit_cd) { if (str_cmd.empty()) return; @@ -704,7 +703,7 @@ void completer_t::complete_cmd(const wcstring &str_cmd, bool use_function, bool /// \param str The string to complete. /// \param args The list of option arguments to be evaluated. /// \param desc Description of the completion -/// \param comp_out The list into which the results will be inserted +/// \param flags The list into which the results will be inserted void completer_t::complete_from_args(const wcstring &str, const wcstring &args, const wcstring &desc, complete_flags_t flags) { bool is_autosuggest = (this->type() == COMPLETE_AUTOSUGGEST); diff --git a/src/complete.h b/src/complete.h index 57c743c0..d9203aaf 100644 --- a/src/complete.h +++ b/src/complete.h @@ -99,6 +99,13 @@ enum { }; typedef uint32_t completion_request_flags_t; +enum complete_option_type_t { + option_type_args_only, // no option + option_type_short, // -x + option_type_single_long, // -foo + option_type_double_long // --foo +}; + /// Add a completion. /// /// All supplied values are copied, they should be freed by or otherwise disposed by the caller. @@ -117,14 +124,12 @@ typedef uint32_t completion_request_flags_t; /// complete -c grep -s d -x -a "read skip recurse" /// /// \param cmd Command to complete. -/// \param cmd_type If cmd_type is PATH, cmd will be interpreted as the absolute +/// \param cmd_is_path If cmd_is_path is true, cmd will be interpreted as the absolute /// path of the program (optionally containing wildcards), otherwise it /// will be interpreted as the command name. -/// \param short_opt The single character name of an option. (-a is a short option, -/// --all and -funroll are long options) -/// \param long_opt The multi character name of an option. (-a is a short option, --all and -/// -funroll are long options) -/// \param long_mode Whether to use old style, single dash long options. +/// \param option The name of an option. +/// \param option_type The type of option: can be option_type_short (-x), +/// option_type_single_long (-foo), option_type_double_long (--bar). /// \param result_mode Whether to search further completions when this completion has been /// succesfully matched. If result_mode is SHARED, any other completions may also be used. If /// result_mode is NO_FILES, file completion should not be used, but other completions may be used. @@ -135,16 +140,12 @@ typedef uint32_t completion_request_flags_t; /// \param condition a command to be run to check it this completion should be used. If \c condition /// is empty, the completion is always used. /// \param flags A set of completion flags -enum complete_option_type_t { - option_type_args_only, // no option - option_type_short, // -x - option_type_single_long, // -foo - option_type_double_long // --foo -}; void complete_add(const wchar_t *cmd, bool cmd_is_path, const wcstring &option, complete_option_type_t option_type, int result_mode, const wchar_t *condition, const wchar_t *comp, const wchar_t *desc, int flags); + + /// Sets whether the completion list for this command is complete. If true, any options not matching /// one of the provided options will be flagged as an error by syntax highlighting. void complete_set_authoritative(const wchar_t *cmd, bool cmd_type, bool authoritative); diff --git a/src/exec.cpp b/src/exec.cpp index aefdbc12..a5bdbc0b 100644 --- a/src/exec.cpp +++ b/src/exec.cpp @@ -315,7 +315,7 @@ static bool io_transmogrify(const io_chain_t &in_chain, io_chain_t *out_chain, /// \param def the code to evaluate, or the empty string if none /// \param node_offset the offset of the node to evalute, or NODE_OFFSET_INVALID /// \param block_type the type of block to push on evaluation -/// \param io the io redirections to be performed on this block +/// \param ios the io redirections to be performed on this block static void internal_exec_helper(parser_t &parser, const wcstring &def, node_offset_t node_offset, enum block_type_t block_type, const io_chain_t &ios) { // If we have a valid node offset, then we must not have a string to execute. diff --git a/src/expand.h b/src/expand.h index 7c82d72e..2f1dd2a6 100644 --- a/src/expand.h +++ b/src/expand.h @@ -33,7 +33,7 @@ enum { /// Don't generate descriptions. EXPAND_NO_DESCRIPTIONS = 1 << 6, /// Don't expand jobs (but you can still expand processes). This is because - // job expansion is not thread safe. + /// job expansion is not thread safe. EXPAND_SKIP_JOBS = 1 << 7, /// Don't expand home directories. EXPAND_SKIP_HOME_DIRECTORIES = 1 << 8, @@ -46,7 +46,7 @@ enum { /// working directories. EXPAND_SPECIAL_FOR_CD = 1 << 11, /// Do expansions specifically to support external command completions. This means using PATH as - // a list of potential working directories. + /// a list of potential working directories. EXPAND_SPECIAL_FOR_COMMAND = 1 << 12 }; typedef int expand_flags_t; @@ -109,7 +109,7 @@ enum expand_error_t { /// /// \param input The parameter to expand /// \param output The list to which the result will be appended. -/// \param flag Specifies if any expansion pass should be skipped. Legal values are any combination +/// \param flags Specifies if any expansion pass should be skipped. Legal values are any combination /// of EXPAND_SKIP_CMDSUBST EXPAND_SKIP_VARIABLES and EXPAND_SKIP_WILDCARDS /// \param errors Resulting errors, or NULL to ignore /// @@ -123,7 +123,7 @@ __warn_unused expand_error_t expand_string(const wcstring &input, std::vectorcommand_line; long match_highlight_pos = (long)el->position + match_highlight_pos_adjust; diff --git a/src/screen.h b/src/screen.h index 43e256d1..74cda3be 100644 --- a/src/screen.h +++ b/src/screen.h @@ -149,7 +149,7 @@ class screen_t { /// \param indent the indent to use for the command line /// \param cursor_pos where the cursor is /// \param pager_data any pager data, to append to the screen -/// \param position_is_within_pager whether the position is within the pager line (first line) +/// \param cursor_is_within_pager whether the position is within the pager line (first line) void s_write(screen_t *s, const wcstring &left_prompt, const wcstring &right_prompt, const wcstring &commandline, size_t explicit_len, const highlight_spec_t *colors, const int *indent, size_t cursor_pos, const page_rendering_t &pager_data, -- cgit v1.2.3