diff options
| author | OpportunityLiu <[email protected]> | 2019-07-24 10:42:55 +0800 |
|---|---|---|
| committer | OpportunityLiu <[email protected]> | 2019-07-24 10:42:55 +0800 |
| commit | b1a47544b8f60c12541b8b5a0f4383639d348af3 (patch) | |
| tree | ea52bf2d354a9d04405ef1fadf1d45b82f5a90af | |
| parent | ae7d6509749944564b939bd36cf6ab895dcff0af (diff) | |
fix typo
184 files changed, 285 insertions, 285 deletions
diff --git a/CHANGELOG.md b/CHANGELOG.md index 54d250642..268d12e01 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -201,7 +201,7 @@ ### Changes -* Improve to configure cross-toolchains, add tool alias to support unknown tool name, .e.g `xmake f [email protected]` +* Improve to configure cross-toolchains, add tool alias to support unknown tool name, e.g. `xmake f [email protected]` * [#151](https://github.com/xmake-io/xmake/issues/151): Improve to build the share library for the mingw platform * Improve to generate makefile plugin * Improve the checking errors tips @@ -230,7 +230,7 @@ ### Changes -* Improve support for IDE/editor plugins (.e.g vscode, sublime, intellij-idea) +* Improve support for IDE/editor plugins (e.g. vscode, sublime, intellij-idea) * Add `.gitignore` file when creating new projects * Improve to create template project * Improve to detect toolchains on macosx without xcode @@ -280,7 +280,7 @@ * Improve `add_files` to configure the compile option of the given files * Inherit links and linkdirs from the dependent targets and options -* Improve `target.add_deps` and add inherit config, .e.g `add_deps("test", {inherit = false})` +* Improve `target.add_deps` and add inherit config, e.g. `add_deps("test", {inherit = false})` * Remove the binary files of `tbox.pkg` * Use `/Zi` instead of `/ZI` for msvc @@ -298,7 +298,7 @@ * [#83](https://github.com/xmake-io/xmake/issues/83): Add user extension modules to detect program, libraries and files. * Add `find_program`, `find_file`, `find_library`, `find_tool` and `find_package` module interfaces. * Add `net.*` and `devel.*` extension modules -* Add `val()` api to get the value of builtin-variable, .e.g `val("host")`, `val("env PATH")`, `val("shell echo hello")` and `val("reg HKEY_LOCAL_MACHINE\\XX;Value")` +* Add `val()` api to get the value of builtin-variable, e.g. `val("host")`, `val("env PATH")`, `val("shell echo hello")` and `val("reg HKEY_LOCAL_MACHINE\\XX;Value")` * Support to compile the microsoft resource file (.rc) * Add `has_flags`, `features` and `has_features` for detect module interfaces. * Add `option.on_check`, `option.after_check` and `option.before_check` api @@ -320,7 +320,7 @@ * Improve `print` interface to dump table * [#111](https://github.com/xmake-io/xmake/issues/111): Add `--root` common option to allow run xmake command as root * [#113](https://github.com/xmake-io/xmake/pull/113): Privilege manage when running as root, store the root privilege and degrade. -* Improve `xxx_script` in `xmake.lua` to support pattern match, .e.g `on_build("iphoneos|arm*", function (target) end)` +* Improve `xxx_script` in `xmake.lua` to support pattern match, e.g. `on_build("iphoneos|arm*", function (target) end)` * improve builtin-variables to support to get the value envirnoment and registry * Improve to detect vstudio sdk and cross toolchains envirnoment * [#71](https://github.com/xmake-io/xmake/issues/71): Improve to detect compiler and linker from env vars @@ -470,7 +470,7 @@ ### New features -* Add native shell support for `xmake.lua`. .e.g `add_ldflags("$(shell pkg-config --libs sqlite3)")` +* Add native shell support for `xmake.lua`. e.g. `add_ldflags("$(shell pkg-config --libs sqlite3)")` * Enable pdb symbol files for windows * Add debugger support on windows (vsjitdebugger, ollydbg, windbg ... ) * Add `getenv` interface for the global scope of `xmake.lua` @@ -493,7 +493,7 @@ * Add check includes dependence automatically * Add print colors -* Add debugger support, .e.g `xmake run -d program ...` +* Add debugger support, e.g. `xmake run -d program ...` ### Changes @@ -532,7 +532,7 @@ * Add task api for running custom tasks * Add plugin expansion and provide some builtin plugins -* Add export ide project plugin(.e.g makefile and will support to export other projects for vs, xcode in feature) +* Add export ide project plugin(e.g. makefile and will support to export other projects for vs, xcode in feature) * Add demo plugin for printing 'hello xmake' * Add make doxygen documents plugin * Add macro script plugin @@ -555,7 +555,7 @@ * Modify some api name, but be compatible with the old version * Optimize merging static library * Simplify cross compilation using argument `--sdk=xxx` -* Simplify boolean option for command line, .e.g `xmake config --xxx=[y|n|yes|no|true|false]` +* Simplify boolean option for command line, e.g. `xmake config --xxx=[y|n|yes|no|true|false]` * Merge iphoneos and iphonesimulator platforms * Merge watchos and watchsimulator platformss @@ -595,7 +595,7 @@ ### New features * Add `set_runscript` api and support custom action -* Add import api and support import modules in xmake.lua, .e.g os, path, utils ... +* Add import api and support import modules in xmake.lua, e.g. os, path, utils ... * Add new architecture: arm64-v8a for android ### Bugs fixed diff --git a/core/src/xmake/string/convert.c b/core/src/xmake/string/convert.c index 49ad3ca7a..baf27ace2 100644 --- a/core/src/xmake/string/convert.c +++ b/core/src/xmake/string/convert.c @@ -92,7 +92,7 @@ static xm_charset_entry_ref_t xm_string_charset_find_by_name(tb_char_t const* na /* convert string * * @param str the string - * @param ftype the from-charset type, .e.g ascii, gb2312, gbk, ios8859, ucs2, ucs4, utf8, utf16, utf32 + * @param ftype the from-charset type, e.g. ascii, gb2312, gbk, ios8859, ucs2, ucs4, utf8, utf16, utf32 * @param ttype the to-charset type * * @code diff --git a/scripts/debian/control b/scripts/debian/control index 1b8756847..c75388c2d 100644 --- a/scripts/debian/control +++ b/scripts/debian/control @@ -13,7 +13,7 @@ Architecture: any Depends: ${shlibs:Depends}, ${misc:Depends} Description: A make-like build utility based on Lua xmake focuses on making development and building easier and - provides many features (.e.g package, install, plugin, macro, + provides many features (e.g. package, install, plugin, macro, action, option, task ...), so that any developer can quickly pick it up and enjoy the productivity boost when developing and building project. diff --git a/tests/ui/dialog.lua b/tests/ui/dialog.lua index f65c7eee0..7a052cbf5 100644 --- a/tests/ui/dialog.lua +++ b/tests/ui/dialog.lua @@ -52,7 +52,7 @@ function demo:init() -- init main dialog local dialog_main = boxdialog:new("dialog.main", rect {1, 1, self:width() - 1, self:height() - 1}, "main dialog") - dialog_main:text():text_set("The project focuses on making development and building easier and provides many features (.e.g package, install, plugin, macro, action, option, task ...), so that any developer can quickly pick it up and enjoy the productivity boost when developing and building project.") + dialog_main:text():text_set("The project focuses on making development and building easier and provides many features (e.g. package, install, plugin, macro, action, option, task ...), so that any developer can quickly pick it up and enjoy the productivity boost when developing and building project.") dialog_main:button_add("tips", "< Tips >", function (v) self:view("dialog.tips"):show(true, {focused = true}) end) dialog_main:button_add("input", "< Input >", function (v) self:view("dialog.input"):show(true, {focused = true}) end) dialog_main:button_add("help", "< Help >", function (v) self:insert(dialog_help) end) diff --git a/xmake/actions/install/xmake.lua b/xmake/actions/install/xmake.lua index ad370ba19..d8f0d6ebf 100644 --- a/xmake/actions/install/xmake.lua +++ b/xmake/actions/install/xmake.lua @@ -42,12 +42,12 @@ task("install") , options = { {'o', "installdir", "kv", nil, "Set the install directory.", - ".e.g", + "e.g.", " $ xmake install -o /usr/local", "or $ DESTDIR=/usr/local xmake install", "or $ INSTALLDIR=/usr/local xmake install" } , {'p', "prefix", "kv", nil, "Set the prefix directory.", - ".e.g", + "e.g.", " $ xmake install --prefix=local", "or $ PREFIX=local xmake install" } , {'a', "all", "k", nil, "Install all targets." } diff --git a/xmake/actions/require/impl/package.lua b/xmake/actions/require/impl/package.lua index 454b713c4..7f56fa7c2 100644 --- a/xmake/actions/require/impl/package.lua +++ b/xmake/actions/require/impl/package.lua @@ -66,7 +66,7 @@ function _parse_require(require_str, requires_extra, parentinfo) -- get version -- - -- .e.g + -- e.g. -- -- lastest -- >=1.5.1 <1.6.0 @@ -187,7 +187,7 @@ end -- sort package deps -- --- .e.g +-- e.g. -- -- a.deps = b -- b.deps = c diff --git a/xmake/actions/uninstall/xmake.lua b/xmake/actions/uninstall/xmake.lua index 873be9ab1..e3ae220a4 100644 --- a/xmake/actions/uninstall/xmake.lua +++ b/xmake/actions/uninstall/xmake.lua @@ -42,12 +42,12 @@ task("uninstall") , options = { {nil, "installdir", "kv", nil, "Set the install directory.", - ".e.g", + "e.g.", " $ xmake uninstall -o /usr/local", "or $ DESTDIR=/usr/local xmake uninstall", "or $ INSTALLDIR=/usr/local xmake uninstall" } , {'p', "prefix", "kv", nil, "Set the prefix directory.", - ".e.g", + "e.g.", " $ xmake uninstall --prefix=local", "or $ PREFIX=local xmake uninstall" } , { } diff --git a/xmake/core/base/dlist.lua b/xmake/core/base/dlist.lua index 34a85e32b..050e4d7d3 100644 --- a/xmake/core/base/dlist.lua +++ b/xmake/core/base/dlist.lua @@ -176,7 +176,7 @@ end -- get items -- --- .e.g +-- e.g. -- -- for item in dlist:items() do -- print(item) diff --git a/xmake/core/base/filter.lua b/xmake/core/base/filter.lua index aa444f368..f65c30d46 100644 --- a/xmake/core/base/filter.lua +++ b/xmake/core/base/filter.lua @@ -47,7 +47,7 @@ end -- filter the shell command -- --- .e.g +-- e.g. -- -- print("$(shell echo hello xmake)") -- add_ldflags("$(shell pkg-config --libs sqlite3)") @@ -152,7 +152,7 @@ end -- filter the builtin variables: "hello $(variable)" for string -- --- .e.g +-- e.g. -- -- print("$(host)") -- print("$(env PATH)") diff --git a/xmake/core/base/global.lua b/xmake/core/base/global.lua index 5beb65674..5a4132b1f 100644 --- a/xmake/core/base/global.lua +++ b/xmake/core/base/global.lua @@ -54,7 +54,7 @@ end -- -- @param name the name -- @param value the value --- @param opt the argument options, .e.g {readonly = false, force = false} +-- @param opt the argument options, e.g. {readonly = false, force = false} -- function global.set(name, value, opt) diff --git a/xmake/core/base/interpreter.lua b/xmake/core/base/interpreter.lua index 89dd7d5c1..fe401f262 100644 --- a/xmake/core/base/interpreter.lua +++ b/xmake/core/base/interpreter.lua @@ -87,7 +87,7 @@ function interpreter._merge_root_scope(root, root_prev, override) root_prev = root_prev or {} for scope_kind_and_name, _ in pairs(root or {}) do -- only merge sub-scope for each kind("target@@xxxx") or __rootkind - -- we need ignore the sub-root scope .e.g target{} after fetching root scope + -- we need ignore the sub-root scope e.g. target{} after fetching root scope -- if scope_kind_and_name:find("@@", 1, true) or scope_kind_and_name == "__rootkind" then local scope_values = root_prev[scope_kind_and_name] or {} @@ -142,10 +142,10 @@ function interpreter._fetch_root_scope(root) end end --- save api source info, .e.g call api() in sourcefile:linenumber +-- save api source info, e.g. call api() in sourcefile:linenumber function interpreter:_save_sourceinfo_to_scope(scope, apiname, values) - -- save api source info, .e.g call api() in sourcefile:linenumber + -- save api source info, e.g. call api() in sourcefile:linenumber local sourceinfo = debug.getinfo(3, "Sl") if sourceinfo then scope["__sourceinfo_" .. apiname] = scope["__sourceinfo_" .. apiname] or {} @@ -260,7 +260,7 @@ function interpreter:_api_register_xxx_values(scope_kind, action, apifunc, ...) scope["__override_" .. apiname] = true end - -- save api source info, .e.g call api() in sourcefile:linenumber + -- save api source info, e.g. call api() in sourcefile:linenumber self:_save_sourceinfo_to_scope(scope, apiname, {...}) -- call function @@ -959,7 +959,7 @@ function interpreter:api_register_scope(...) -- with scope info? translate it -- - -- .e.g + -- e.g. -- option("text", {showmenu = true, default = true, description = "test option"}) -- target("tbox", {kind = "static", files = {"src/*.c", "*.cpp"}}) -- @@ -1274,7 +1274,7 @@ function interpreter:api_register_set_pathes(scope_kind, ...) end end - -- save api source info, .e.g call api() in sourcefile:linenumber + -- save api source info, e.g. call api() in sourcefile:linenumber self:_save_sourceinfo_to_scope(scope, name, pathes) end @@ -1304,7 +1304,7 @@ function interpreter:api_register_del_pathes(scope_kind, ...) -- save values scope[name] = table.join2(scope[name] or {}, pathes_deleted) - -- save api source info, .e.g call api() in sourcefile:linenumber + -- save api source info, e.g. call api() in sourcefile:linenumber self:_save_sourceinfo_to_scope(scope, name, pathes) end @@ -1345,7 +1345,7 @@ function interpreter:api_register_add_pathes(scope_kind, ...) end end - -- save api source info, .e.g call api() in sourcefile:linenumber + -- save api source info, e.g. call api() in sourcefile:linenumber self:_save_sourceinfo_to_scope(scope, name, pathes) end diff --git a/xmake/core/base/os.lua b/xmake/core/base/os.lua index b8d767efd..57353d4d8 100644 --- a/xmake/core/base/os.lua +++ b/xmake/core/base/os.lua @@ -296,7 +296,7 @@ end -- match directories -- --- @note only return {} without count to simplify code, .e.g unpack(os.dirs("")) +-- @note only return {} without count to simplify code, e.g. unpack(os.dirs("")) -- function os.dirs(pattern, callback) return (os.match(pattern, 'd', callback)) @@ -582,7 +582,7 @@ end -- @param program "clang", "xcrun -sdk macosx clang", "~/dir/test\ xxx/clang" -- filename "clang", "xcrun"", "~/dir/test\ xxx/clang" -- @param argv the arguments --- @param opt the options, .e.g {wildcards = false, stdout = outfile, stderr = errfile, +-- @param opt the options, e.g. {wildcards = false, stdout = outfile, stderr = errfile, -- envs = {PATH = "xxx;xx", CFLAGS = "xx"}} -- function os.execv(program, argv, opt) @@ -603,7 +603,7 @@ function os.execv(program, argv, opt) local filename = program if not os.isexec(program) then - -- parse the filename and arguments, .e.g "xcrun -sdk macosx clang" + -- parse the filename and arguments, e.g. "xcrun -sdk macosx clang" local splitinfo = program:split("%s") filename = splitinfo[1] if #splitinfo > 1 then diff --git a/xmake/core/base/path.lua b/xmake/core/base/path.lua index 8b35a771c..5cb7db15d 100644 --- a/xmake/core/base/path.lua +++ b/xmake/core/base/path.lua @@ -197,7 +197,7 @@ end -- convert path pattern to a lua pattern function path.pattern(pattern) - -- translate wildcards, .e.g *, ** + -- translate wildcards, e.g. *, ** pattern = pattern:gsub("([%+%.%-%^%$%(%)%%])", "%%%1") pattern = pattern:gsub("%*%*", "\001") pattern = pattern:gsub("%*", "\002") diff --git a/xmake/core/base/scopeinfo.lua b/xmake/core/base/scopeinfo.lua index 3028883eb..c16cd096a 100644 --- a/xmake/core/base/scopeinfo.lua +++ b/xmake/core/base/scopeinfo.lua @@ -77,10 +77,10 @@ function _instance:_api_handle(values) return table.unwrap(values) end --- save api source info, .e.g call api() in sourcefile:linenumber +-- save api source info, e.g. call api() in sourcefile:linenumber function _instance:_api_save_sourceinfo_to_scope(scope, apiname, values) - -- save api source info, .e.g call api() in sourcefile:linenumber + -- save api source info, e.g. call api() in sourcefile:linenumber local sourceinfo = debug.getinfo(5, "Sl") if sourceinfo then scope["__sourceinfo_" .. apiname] = scope["__sourceinfo_" .. apiname] or {} @@ -313,7 +313,7 @@ function _instance:_api_set_pathes(name, ...) end end - -- save api source info, .e.g call api() in sourcefile:linenumber + -- save api source info, e.g. call api() in sourcefile:linenumber self:_api_save_sourceinfo_to_scope(scope, name, pathes) end @@ -353,7 +353,7 @@ function _instance:_api_add_pathes(name, ...) end end - -- save api source info, .e.g call api() in sourcefile:linenumber + -- save api source info, e.g. call api() in sourcefile:linenumber self:_api_save_sourceinfo_to_scope(scope, name, pathes) end @@ -381,7 +381,7 @@ function _instance:_api_del_pathes(name, ...) -- save values scope[name] = self:_api_handle(table.join2(table.wrap(scope[name]), pathes_deleted)) - -- save api source info, .e.g call api() in sourcefile:linenumber + -- save api source info, e.g. call api() in sourcefile:linenumber self:_api_save_sourceinfo_to_scope(scope, name, pathes) end diff --git a/xmake/core/base/semver.lua b/xmake/core/base/semver.lua index c6e1a563c..73d5f48c5 100644 --- a/xmake/core/base/semver.lua +++ b/xmake/core/base/semver.lua @@ -78,7 +78,7 @@ function _instance:shortstr() return str end --- satisfies the given semantic version(.e.g '> 1.0 < 2.0', '~1.5')? +-- satisfies the given semantic version(e.g. '> 1.0 < 2.0', '~1.5')? function _instance:satisfies(version) return semver.satisfies(self:rawstr(), version) end diff --git a/xmake/core/language/language.lua b/xmake/core/language/language.lua index ee57172fe..f084a4c6a 100644 --- a/xmake/core/language/language.lua +++ b/xmake/core/language/language.lua @@ -120,7 +120,7 @@ end -- get the target kinds (targetkind => linkerkind) -- --- .e.g +-- e.g. -- {binary = "ld", static = "ar", shared = "sh"} -- function _instance:targetkinds() @@ -129,7 +129,7 @@ end -- get the target flags (targetkind => linkerflag) -- --- .e.g +-- e.g. -- {binary = "ldflags", static = "arflags", shared = "shflags"} -- function _instance:targetflags() @@ -138,7 +138,7 @@ end -- get the mixing kinds for linker -- --- .e.g +-- e.g. -- {"cc", "cxx"} -- function _instance:mixingkinds() @@ -428,7 +428,7 @@ end -- get language source extensions -- --- .e.g +-- e.g. -- -- { -- [".c"] = cc @@ -468,7 +468,7 @@ end -- get language source kinds -- --- .e.g +-- e.g. -- -- { -- cc = ".c" @@ -507,7 +507,7 @@ end -- get language source flags -- --- .e.g +-- e.g. -- -- { -- cc = {"cflags", "cxflags"} @@ -643,7 +643,7 @@ end -- get language target kinds -- --- .e.g +-- e.g. -- -- { -- binary = {"ld", "gc-ld", "dc-ld"} @@ -685,7 +685,7 @@ end -- get language kinds (langkind => sourcekind) -- --- .e.g +-- e.g. -- -- { -- c = "cc" diff --git a/xmake/core/package/package.lua b/xmake/core/package/package.lua index b9147b7c5..7d7fe8f67 100644 --- a/xmake/core/package/package.lua +++ b/xmake/core/package/package.lua @@ -742,9 +742,9 @@ end -- fetch the local package info -- --- @param opt the fetch option, .e.g {force = true, system = false} +-- @param opt the fetch option, e.g. {force = true, system = false} -- --- @return {packageinfo}, fetchfrom (.e.g xmake/system) +-- @return {packageinfo}, fetchfrom (e.g. xmake/system) -- function _instance:fetch(opt) @@ -893,7 +893,7 @@ end -- has the given c funcs? -- -- @param funcs the funcs --- @param opt the argument options, .e.g { includes = ""} +-- @param opt the argument options, e.g. { includes = ""} -- -- @return true or false -- @@ -910,7 +910,7 @@ end -- has the given c++ funcs? -- -- @param funcs the funcs --- @param opt the argument options, .e.g { includes = ""} +-- @param opt the argument options, e.g. { includes = ""} -- -- @return true or false -- @@ -927,7 +927,7 @@ end -- check the given c snippets? -- -- @param snippets the snippets --- @param opt the argument options, .e.g { includes = ""} +-- @param opt the argument options, e.g. { includes = ""} -- -- @return true or false -- @@ -944,7 +944,7 @@ end -- check the given c++ snippets? -- -- @param snippets the snippets --- @param opt the argument options, .e.g { includes = ""} +-- @param opt the argument options, e.g. { includes = ""} -- -- @return true or false -- diff --git a/xmake/core/platform/platform.lua b/xmake/core/platform/platform.lua index 3d79c52bc..fa94ff0d6 100644 --- a/xmake/core/platform/platform.lua +++ b/xmake/core/platform/platform.lua @@ -306,7 +306,7 @@ end -- get the platform tool from the kind -- --- .e.g cc, cxx, mm, mxx, as, ar, ld, sh, .. +-- e.g. cc, cxx, mm, mxx, as, ar, ld, sh, .. -- function platform.tool(toolkind, plat) @@ -332,7 +332,7 @@ function platform.tool(toolkind, plat) toolname = config.get("__toolname_" .. toolkind) end - -- contain toolname? parse it, .e.g '[email protected]' + -- contain toolname? parse it, e.g. '[email protected]' if program and type(program) == "string" then local pos = program:find('@', 1, true) if pos then diff --git a/xmake/core/project/config.lua b/xmake/core/project/config.lua index 75c8d94c7..6c914de01 100644 --- a/xmake/core/project/config.lua +++ b/xmake/core/project/config.lua @@ -85,7 +85,7 @@ end -- -- @param name the name -- @param value the value --- @param opt the argument options, .e.g {readonly = false, force = false} +-- @param opt the argument options, e.g. {readonly = false, force = false} -- function config.set(name, value, opt) diff --git a/xmake/core/project/option.lua b/xmake/core/project/option.lua index 357cb5380..c5a8c7322 100644 --- a/xmake/core/project/option.lua +++ b/xmake/core/project/option.lua @@ -258,7 +258,7 @@ end -- enable or disable this option -- -- @param enabled enable option? --- @param opt the argument options, .e.g {readonly = true, force = false} +-- @param opt the argument options, e.g. {readonly = true, force = false} -- function _instance:enable(enabled, opt) diff --git a/xmake/core/project/project.lua b/xmake/core/project/project.lua index 6e670ec3b..581d16e1e 100644 --- a/xmake/core/project/project.lua +++ b/xmake/core/project/project.lua @@ -350,9 +350,9 @@ function project._load(force, disable_filter) return true end --- load deps for instance: .e.g option, target and rule +-- load deps for instance: e.g. option, target and rule -- --- .e.g +-- e.g. -- -- a.deps = b -- b.deps = c @@ -500,7 +500,7 @@ function project._load_targets() -- load rules from target and language -- - -- .e.g + -- e.g. -- -- a.deps = b -- b.deps = c diff --git a/xmake/core/project/rule.lua b/xmake/core/project/rule.lua index 1e03c0d55..dcf469005 100644 --- a/xmake/core/project/rule.lua +++ b/xmake/core/project/rule.lua @@ -123,7 +123,7 @@ end -- load deps -- --- .e.g +-- e.g. -- -- a.deps = b -- b.deps = c diff --git a/xmake/core/project/target.lua b/xmake/core/project/target.lua index a4c194a15..484d97639 100644 --- a/xmake/core/project/target.lua +++ b/xmake/core/project/target.lua @@ -1046,7 +1046,7 @@ function _instance:objectfile(sourcefile) -- translate path -- - -- .e.g + -- e.g. -- -- src/xxx.c -- project/xmake.lua @@ -1304,7 +1304,7 @@ end -- get the kinds of sourcefiles -- --- .e.g cc cxx mm mxx as ... +-- e.g. cc cxx mm mxx as ... -- function _instance:sourcekinds() diff --git a/xmake/core/sandbox/modules/import/core/base/global.lua b/xmake/core/sandbox/modules/import/core/base/global.lua index 108bbaa84..b39bbc73b 100644 --- a/xmake/core/sandbox/modules/import/core/base/global.lua +++ b/xmake/core/sandbox/modules/import/core/base/global.lua @@ -37,7 +37,7 @@ end -- -- @param name the name -- @param value the value --- @param opt the argument options, .e.g {readonly = false, force = false} +-- @param opt the argument options, e.g. {readonly = false, force = false} -- function sandbox_core_base_global.set(name, value, opt) global.set(name, value, opt) diff --git a/xmake/core/sandbox/modules/import/core/base/semver.lua b/xmake/core/sandbox/modules/import/core/base/semver.lua index bfd02d5af..6e43e0ad9 100644 --- a/xmake/core/sandbox/modules/import/core/base/semver.lua +++ b/xmake/core/sandbox/modules/import/core/base/semver.lua @@ -74,12 +74,12 @@ end -- select required version from versions, tags and branches -- --- .e.g +-- e.g. -- -- local version, source = semver.select(">=1.5.0 <1.6", {"1.5.0", "1.5.1"}, {"v1.5.0", ..}, {"master", "dev"}) -- -- @version the selected version number --- @source the version source, .e.g versions, tags, branchs +-- @source the version source, e.g. versions, tags, branchs -- function sandbox_core_base_semver.select(range, versions, tags, branches) local verinfo, errors = semver.select(range, table.wrap(versions), table.wrap(tags), table.wrap(branches)) diff --git a/xmake/core/sandbox/modules/import/core/platform/platform.lua b/xmake/core/sandbox/modules/import/core/platform/platform.lua index a66e80442..5655dd006 100644 --- a/xmake/core/sandbox/modules/import/core/platform/platform.lua +++ b/xmake/core/sandbox/modules/import/core/platform/platform.lua @@ -57,7 +57,7 @@ end -- get the platform tool from the kind -- --- .e.g cc, cxx, mm, mxx, as, ar, ld, sh, .. +-- e.g. cc, cxx, mm, mxx, as, ar, ld, sh, .. -- function sandbox_core_platform.tool(toolkind) return platform.tool(toolkind) diff --git a/xmake/core/sandbox/modules/import/core/project/config.lua b/xmake/core/sandbox/modules/import/core/project/config.lua index 2252de0be..fdcd858b7 100644 --- a/xmake/core/sandbox/modules/import/core/project/config.lua +++ b/xmake/core/sandbox/modules/import/core/project/config.lua @@ -71,7 +71,7 @@ end -- -- @param name the name -- @param value the value --- @param opt the argument options, .e.g {readonly = false, force = false} +-- @param opt the argument options, e.g. {readonly = false, force = false} -- function sandbox_core_project_config.set(name, value, opt) return config.set(name, value, opt) diff --git a/xmake/core/sandbox/modules/import/core/sandbox/module.lua b/xmake/core/sandbox/modules/import/core/sandbox/module.lua index 996efd0f5..28e80c2c2 100644 --- a/xmake/core/sandbox/modules/import/core/sandbox/module.lua +++ b/xmake/core/sandbox/modules/import/core/sandbox/module.lua @@ -325,12 +325,12 @@ end -- import module -- --- @param name the module name, .e.g core.platform --- @param opt the argument options, .e.g {alias = "", nolocal = true, rootdir = "", try = false, inherit = false, anonymous = false, nocache = false} +-- @param name the module name, e.g. core.platform +-- @param opt the argument options, e.g. {alias = "", nolocal = true, rootdir = "", try = false, inherit = false, anonymous = false, nocache = false} -- -- @return the module instance -- --- .e.g +-- e.g. -- -- import("core.platform") -- => platform @@ -451,7 +451,7 @@ function core_sandbox_module.import(name, opt) -- -- we can access the all scope members of _super in the child module -- - -- .e.g + -- e.g. -- -- import("core.platform.xxx", {inherit = true}) -- diff --git a/xmake/core/sandbox/modules/import/core/tool/compiler.lua b/xmake/core/sandbox/modules/import/core/tool/compiler.lua index a3e81f10b..f93176181 100644 --- a/xmake/core/sandbox/modules/import/core/tool/compiler.lua +++ b/xmake/core/sandbox/modules/import/core/tool/compiler.lua @@ -103,7 +103,7 @@ end -- -- @param sourcefiles the source files -- @param opt the argument options (contain all the compiler attributes of target), --- .e.g {target = ..., targetkind = "static", config = {cxflags = "", defines = "", includedirs = "", ...}} +-- e.g. {target = ..., targetkind = "static", config = {cxflags = "", defines = "", includedirs = "", ...}} -- -- @return the flags list -- @@ -178,9 +178,9 @@ end -- get all compiler features -- --- @param langkind the language kind, .e.g c, cxx, mm, mxx, swift, go, rust, d, as +-- @param langkind the language kind, e.g. c, cxx, mm, mxx, swift, go, rust, d, as -- @param opt the argument options (contain all the compiler attributes of target), --- .e.g {target = ..., targetkind = "static", cxflags = "", defines = "", includedirs = "", ...} +-- e.g. {target = ..., targetkind = "static", cxflags = "", defines = "", includedirs = "", ...} -- -- @return the features -- @@ -219,9 +219,9 @@ end -- has the given features? -- --- @param features the features, .e.g {"c_static_assert", "cxx_constexpr"} +-- @param features the features, e.g. {"c_static_assert", "cxx_constexpr"} -- @param opt the argument options (contain all the compiler attributes of target), --- .e.g {target = ..., targetkind = "static", cxflags = "", defines = "", includedirs = "", ...} +-- e.g. {target = ..., targetkind = "static", cxflags = "", defines = "", includedirs = "", ...} -- -- @return the supported features or nil -- @@ -284,7 +284,7 @@ end -- has the given flags? -- --- @param langkind the language kind, .e.g c, cxx, mm, mxx, swift, go, rust, d, as +-- @param langkind the language kind, e.g. c, cxx, mm, mxx, swift, go, rust, d, as -- @param flags the flags -- @param options the options -- diff --git a/xmake/core/sandbox/modules/import/core/tool/linker.lua b/xmake/core/sandbox/modules/import/core/tool/linker.lua index 8d8a5dc7b..5afa28ce2 100644 --- a/xmake/core/sandbox/modules/import/core/tool/linker.lua +++ b/xmake/core/sandbox/modules/import/core/tool/linker.lua @@ -62,7 +62,7 @@ end -- @param targetkind the target kind -- @param sourcekinds the source kinds -- @param opt the argument options (contain all the linker attributes of target), --- .e.g {target = ..., targetkind = "static", config = {cxflags = "", defines = "", includedirs = "", ...}} +-- e.g. {target = ..., targetkind = "static", config = {cxflags = "", defines = "", includedirs = "", ...}} -- function sandbox_core_tool_linker.linkflags(targetkind, sourcekinds, opt) diff --git a/xmake/core/sandbox/modules/import/lib/detect/cache.lua b/xmake/core/sandbox/modules/import/lib/detect/cache.lua index 31930a962..c85df7f07 100644 --- a/xmake/core/sandbox/modules/import/lib/detect/cache.lua +++ b/xmake/core/sandbox/modules/import/lib/detect/cache.lua @@ -43,7 +43,7 @@ end -- load detect cache -- --- @param name the cache name. .e.g find_program, find_programver, .. +-- @param name the cache name. e.g. find_program, find_programver, .. -- function sandbox_lib_detect_cache.load(name) @@ -63,7 +63,7 @@ end -- save detect cache -- --- @param name the cache name. .e.g find_program, find_programver, .. +-- @param name the cache name. e.g. find_program, find_programver, .. -- @param info the cache info -- function sandbox_lib_detect_cache.save(name, info) @@ -78,7 +78,7 @@ end -- clear detect cache -- --- @param name the cache name. .e.g find_program, find_programver, .. +-- @param name the cache name. e.g. find_program, find_programver, .. -- function sandbox_lib_detect_cache.clear(name) diff --git a/xmake/core/sandbox/modules/import/lib/detect/find_directory.lua b/xmake/core/sandbox/modules/import/lib/detect/find_directory.lua index 02aa95232..bd52e3fb3 100644 --- a/xmake/core/sandbox/modules/import/lib/detect/find_directory.lua +++ b/xmake/core/sandbox/modules/import/lib/detect/find_directory.lua @@ -32,8 +32,8 @@ local vformat = require("sandbox/modules/vformat") -- find directory -- -- @param name the directory name --- @param pathes the search pathes (.e.g dirs, pathes, winreg pathes) --- @param opt the options, .e.g {suffixes = {"/aa", "/bb"}} +-- @param pathes the search pathes (e.g. dirs, pathes, winreg pathes) +-- @param opt the options, e.g. {suffixes = {"/aa", "/bb"}} -- -- @return the directory path -- diff --git a/xmake/core/sandbox/modules/import/lib/detect/find_file.lua b/xmake/core/sandbox/modules/import/lib/detect/find_file.lua index 45a3ebd8a..96f4b5218 100644 --- a/xmake/core/sandbox/modules/import/lib/detect/find_file.lua +++ b/xmake/core/sandbox/modules/import/lib/detect/find_file.lua @@ -50,8 +50,8 @@ end -- find file -- -- @param name the file name --- @param pathes the search pathes (.e.g dirs, pathes, winreg pathes) --- @param opt the options, .e.g {suffixes = {"/aa", "/bb"}} +-- @param pathes the search pathes (e.g. dirs, pathes, winreg pathes) +-- @param opt the options, e.g. {suffixes = {"/aa", "/bb"}} -- -- @return the file path -- diff --git a/xmake/core/sandbox/modules/import/lib/detect/find_library.lua b/xmake/core/sandbox/modules/import/lib/detect/find_library.lua index a3fd9e43b..3cd02b985 100644 --- a/xmake/core/sandbox/modules/import/lib/detect/find_library.lua +++ b/xmake/core/sandbox/modules/import/lib/detect/find_library.lua @@ -36,7 +36,7 @@ local find_file = import("lib.detect.find_file") -- -- @param names the library names -- @param pathes the search pathes --- @param opt the options, .e.g {kind = "static/shared", suffixes = {"/aa", "/bb"}} +-- @param opt the options, e.g. {kind = "static/shared", suffixes = {"/aa", "/bb"}} -- -- @return {kind = "static", link = "crypto", linkdir = "/usr/local/lib", filename = "libcrypto.a"} -- diff --git a/xmake/core/sandbox/modules/import/lib/detect/find_path.lua b/xmake/core/sandbox/modules/import/lib/detect/find_path.lua index 216f72513..db6a20408 100644 --- a/xmake/core/sandbox/modules/import/lib/detect/find_path.lua +++ b/xmake/core/sandbox/modules/import/lib/detect/find_path.lua @@ -53,8 +53,8 @@ end -- find path -- -- @param name the path name --- @param pathes the search pathes (.e.g dirs, pathes, winreg pathes) --- @param opt the options, .e.g {suffixes = {"/aa", "/bb"}} +-- @param pathes the search pathes (e.g. dirs, pathes, winreg pathes) +-- @param opt the options, e.g. {suffixes = {"/aa", "/bb"}} -- -- @return the path -- diff --git a/xmake/core/sandbox/modules/import/lib/detect/find_program.lua b/xmake/core/sandbox/modules/import/lib/detect/find_program.lua index f8a62ceaf..998a5e25c 100644 --- a/xmake/core/sandbox/modules/import/lib/detect/find_program.lua +++ b/xmake/core/sandbox/modules/import/lib/detect/find_program.lua @@ -123,7 +123,7 @@ end -- find program from the xmake packages function sandbox_lib_detect_find_program._find_from_packages(name, opt) - -- get the manifest file of package, .e.g ~/.xmake/packages/g/git/1.1.12/ed41d5327fad3fc06fe376b4a94f62ef/manifest.txt + -- get the manifest file of package, e.g. ~/.xmake/packages/g/git/1.1.12/ed41d5327fad3fc06fe376b4a94f62ef/manifest.txt local manifest_file = path.join(package.installdir(), name:sub(1, 1), name, opt.version, opt.buildhash, "manifest.txt") if not os.isfile(manifest_file) then return @@ -217,8 +217,8 @@ end -- find program -- -- @param name the program name --- @param opt the options, .e.g {pathes = {"/usr/bin"}, check = function (program) os.run("%s -h", program) end, verbose = true, force = true, cachekey = "xxx"} --- - opt.pathes the program pathes (.e.g dirs, pathes, winreg pathes, script pathes) +-- @param opt the options, e.g. {pathes = {"/usr/bin"}, check = function (program) os.run("%s -h", program) end, verbose = true, force = true, cachekey = "xxx"} +-- - opt.pathes the program pathes (e.g. dirs, pathes, winreg pathes, script pathes) -- - opt.check the check script or command -- - opt.norun do not attempt to run program to check program fastly -- @@ -237,7 +237,7 @@ end -- function sandbox_lib_detect_find_program.main(name, opt) - -- @note avoid detect the same program in the same time leading to deadlock if running in the coroutine (.e.g ccache) + -- @note avoid detect the same program in the same time leading to deadlock if running in the coroutine (e.g. ccache) local coroutine_running = coroutine.running() if coroutine_running then while checking ~= nil and checking == name do diff --git a/xmake/core/sandbox/modules/import/lib/detect/find_programver.lua b/xmake/core/sandbox/modules/import/lib/detect/find_programver.lua index 24eb4da4e..4814c3558 100644 --- a/xmake/core/sandbox/modules/import/lib/detect/find_programver.lua +++ b/xmake/core/sandbox/modules/import/lib/detect/find_programver.lua @@ -35,7 +35,7 @@ local cache = require("sandbox/modules/import/lib/detect/cache") -- find program version -- -- @param program the program --- @param opt the options, .e.g {command = "--version", parse = "(%d+%.?%d*%.?%d*.-)%s", verbose = true, force = true, cachekey = "xxx"} +-- @param opt the options, e.g. {command = "--version", parse = "(%d+%.?%d*%.?%d*.-)%s", verbose = true, force = true, cachekey = "xxx"} -- - opt.command the version command string or script, default: --version -- - opt.parse the version parse script or lua match pattern -- diff --git a/xmake/core/sandbox/modules/ipairs.lua b/xmake/core/sandbox/modules/ipairs.lua index 10e8b0f85..ee62dd87c 100644 --- a/xmake/core/sandbox/modules/ipairs.lua +++ b/xmake/core/sandbox/modules/ipairs.lua @@ -23,7 +23,7 @@ local table = require("base/table") -- ipairs -- --- .e.g +-- e.g. -- -- @code -- diff --git a/xmake/core/sandbox/modules/irpairs.lua b/xmake/core/sandbox/modules/irpairs.lua index 7f837ed07..76f33c7d9 100644 --- a/xmake/core/sandbox/modules/irpairs.lua +++ b/xmake/core/sandbox/modules/irpairs.lua @@ -23,7 +23,7 @@ local table = require("base/table") -- irpairs -- --- .e.g +-- e.g. -- -- @code -- diff --git a/xmake/core/sandbox/modules/os.lua b/xmake/core/sandbox/modules/os.lua index d8ec0abe4..422f0fbf7 100644 --- a/xmake/core/sandbox/modules/os.lua +++ b/xmake/core/sandbox/modules/os.lua @@ -396,7 +396,7 @@ function sandbox_os.execv(program, argv, opt) -- flush io buffer first for fixing redirect io output order -- - -- .e.g + -- e.g. -- -- xmake run > /tmp/a -- print("xxx1") diff --git a/xmake/core/sandbox/modules/pairs.lua b/xmake/core/sandbox/modules/pairs.lua index 2fc77a550..92f533fe2 100644 --- a/xmake/core/sandbox/modules/pairs.lua +++ b/xmake/core/sandbox/modules/pairs.lua @@ -23,7 +23,7 @@ local table = require("base/table") -- pairs -- --- .e.g +-- e.g. -- -- @code -- diff --git a/xmake/core/sandbox/modules/val.lua b/xmake/core/sandbox/modules/val.lua index d9a56ebfd..a166d62ac 100644 --- a/xmake/core/sandbox/modules/val.lua +++ b/xmake/core/sandbox/modules/val.lua @@ -23,7 +23,7 @@ local sandbox = require("sandbox/sandbox") -- get the variable value of filter -- --- .e.g +-- e.g. -- -- local value = val("host") -- local value = val("env PATH") diff --git a/xmake/core/tool/builder.lua b/xmake/core/tool/builder.lua index 51e284ad5..fc73a94fd 100644 --- a/xmake/core/tool/builder.lua +++ b/xmake/core/tool/builder.lua @@ -437,7 +437,7 @@ function builder:_add_flags_from_language(flags, target, getters) -- -- ignore "nf_" and "_if_ok" -- - -- .e.g + -- e.g. -- -- defines => define -- defines_if_ok => define @@ -472,7 +472,7 @@ function builder:_preprocess_flags(flags) -- remove repeat flags = table.unique(flags) - -- split flag group, .e.g "-I /xxx" => {"-I", "/xxx"} + -- split flag group, e.g. "-I /xxx" => {"-I", "/xxx"} local results = {} for _, flag in ipairs(flags) do flag = flag:trim() diff --git a/xmake/core/tool/compiler.lua b/xmake/core/tool/compiler.lua index 462f623b4..cf0bf3245 100644 --- a/xmake/core/tool/compiler.lua +++ b/xmake/core/tool/compiler.lua @@ -259,7 +259,7 @@ end -- get the compling flags -- -- @param opt the argument options (contain all the compiler attributes of target), --- .e.g +-- e.g. -- {target = ..., targetkind = "static", configs = {defines = "", cxflags = "", includedirs = ""}} -- -- @return flags string, flags list diff --git a/xmake/core/tool/linker.lua b/xmake/core/tool/linker.lua index a82b12918..32f8405c0 100644 --- a/xmake/core/tool/linker.lua +++ b/xmake/core/tool/linker.lua @@ -39,7 +39,7 @@ local compiler = require("tool/compiler") -- add flags from the platform function linker:_add_flags_from_platform(flags, targetkind) - -- attempt to add special lanugage flags first for target kind, .e.g binary.go.gc-ldflags, static.dc-arflags + -- attempt to add special lanugage flags first for target kind, e.g. binary.go.gc-ldflags, static.dc-arflags if targetkind then local toolkind = self:kind() local toolname = self:name() @@ -57,7 +57,7 @@ function linker:_add_flags_from_linker(flags) local toolkind = self:kind() for _, flagkind in ipairs(self:_flagkinds()) do - -- attempt to add special lanugage flags first, .e.g gc-ldflags, dc-arflags + -- attempt to add special lanugage flags first, e.g. gc-ldflags, dc-arflags table.join2(flags, self:get(toolkind .. 'flags') or self:get(flagkind)) end end @@ -210,7 +210,7 @@ end -- get the link flags -- -- @param opt the argument options (contain all the linker attributes of target), --- .e.g {target = ..., targetkind = "static", configs = {ldflags = "", links = "", linkdirs = "", ...}} +-- e.g. {target = ..., targetkind = "static", configs = {ldflags = "", links = "", linkdirs = "", ...}} -- function linker:linkflags(opt) diff --git a/xmake/core/tool/tool.lua b/xmake/core/tool/tool.lua index 43284c58c..a5a12322a 100644 --- a/xmake/core/tool/tool.lua +++ b/xmake/core/tool/tool.lua @@ -129,8 +129,8 @@ end -- load the given tool from the given kind -- --- @param kind the tool kind .e.g cc, cxx, mm, mxx, as, ar, ld, sh, .. --- @param program the tool program, .e.g /xxx/arm-linux-gcc, [email protected] +-- @param kind the tool kind e.g. cc, cxx, mm, mxx, as, ar, ld, sh, .. +-- @param program the tool program, e.g. /xxx/arm-linux-gcc, [email protected] -- function tool.load(kind, program) @@ -143,7 +143,7 @@ function tool.load(kind, program) return tool._TOOLS[key] end - -- contain toolname? parse it, .e.g '[email protected]' + -- contain toolname? parse it, e.g. '[email protected]' local toolname = nil if program then local pos = program:find('@', 1, true) diff --git a/xmake/core/ui/label.lua b/xmake/core/ui/label.lua index e8fc0bfc6..4cf7cff72 100644 --- a/xmake/core/ui/label.lua +++ b/xmake/core/ui/label.lua @@ -83,7 +83,7 @@ function label:textattr() return self:attr("textattr") end --- set text attribute, .e.g textattr_set("yellow onblue bold") +-- set text attribute, e.g. textattr_set("yellow onblue bold") function label:textattr_set(attr) return self:attr_set("textattr", attr) end diff --git a/xmake/core/ui/view.lua b/xmake/core/ui/view.lua index b28da54fa..cb5f3c558 100644 --- a/xmake/core/ui/view.lua +++ b/xmake/core/ui/view.lua @@ -236,7 +236,7 @@ end -- show view? -- --- .e.g +-- e.g. -- v:show(false) -- v:show(true, {focused = true}) -- @@ -404,7 +404,7 @@ function view:background() return background end --- set background, .e.g background_set("blue") +-- set background, e.g. background_set("blue") function view:background_set(color) return self:attr_set("background", color) end diff --git a/xmake/modules/core/tools/cparser.lua b/xmake/modules/core/tools/cparser.lua index ff143ae48..3b1730cc6 100644 --- a/xmake/modules/core/tools/cparser.lua +++ b/xmake/modules/core/tools/cparser.lua @@ -171,7 +171,7 @@ function _compargv1(self, sourcefile, objectfile, flags) local program = self:program() if ccache then - -- parse the filename and arguments, .e.g "xcrun -sdk macosx clang" + -- parse the filename and arguments, e.g. "xcrun -sdk macosx clang" if not os.isexec(program) then argv = table.join(program:split("%s"), argv) else diff --git a/xmake/modules/core/tools/gcc.lua b/xmake/modules/core/tools/gcc.lua index e029f8566..3ec12d580 100644 --- a/xmake/modules/core/tools/gcc.lua +++ b/xmake/modules/core/tools/gcc.lua @@ -302,7 +302,7 @@ end -- make the link arguments list function linkargv(self, objectfiles, targetkind, targetfile, flags) - -- add rpath for dylib (macho), .e.g -install_name @rpath/file.dylib + -- add rpath for dylib (macho), e.g. -install_name @rpath/file.dylib local flags_extra = {} if targetkind == "shared" and targetfile:endswith(".dylib") then table.insert(flags_extra, "-install_name") @@ -378,7 +378,7 @@ function _compargv1(self, sourcefile, objectfile, flags) local program = self:program() if ccache then - -- parse the filename and arguments, .e.g "xcrun -sdk macosx clang" + -- parse the filename and arguments, e.g. "xcrun -sdk macosx clang" if not os.isexec(program) then argv = table.join(program:split("%s"), argv) else diff --git a/xmake/modules/core/tools/nvcc.lua b/xmake/modules/core/tools/nvcc.lua index b863058e6..a2037e64b 100644 --- a/xmake/modules/core/tools/nvcc.lua +++ b/xmake/modules/core/tools/nvcc.lua @@ -245,7 +245,7 @@ end -- make the link arguments list function linkargv(self, objectfiles, targetkind, targetfile, flags) - -- add rpath for dylib (macho), .e.g -install_name @rpath/file.dylib + -- add rpath for dylib (macho), e.g. -install_name @rpath/file.dylib local flags_extra = {} if targetkind == "shared" and targetfile:endswith(".dylib") then table.insert(flags_extra, "-Xlinker") @@ -290,7 +290,7 @@ function _compargv1(self, sourcefile, objectfile, flags) local program = self:program() if ccache then - -- parse the filename and arguments, .e.g "xcrun -sdk macosx clang" + -- parse the filename and arguments, e.g. "xcrun -sdk macosx clang" if not os.isexec(program) then argv = table.join(program:split("%s"), argv) else diff --git a/xmake/modules/core/tools/swiftc.lua b/xmake/modules/core/tools/swiftc.lua index de6800123..91a788fb6 100644 --- a/xmake/modules/core/tools/swiftc.lua +++ b/xmake/modules/core/tools/swiftc.lua @@ -217,7 +217,7 @@ function _compargv1(self, sourcefile, objectfile, flags) local program = self:program() if ccache then - -- parse the filename and arguments, .e.g "xcrun -sdk macosx clang" + -- parse the filename and arguments, e.g. "xcrun -sdk macosx clang" if not os.isexec(program) then argv = table.join(program:split("%s"), argv) else diff --git a/xmake/modules/core/tools/tcc.lua b/xmake/modules/core/tools/tcc.lua index 1efb00eac..e7c11b645 100644 --- a/xmake/modules/core/tools/tcc.lua +++ b/xmake/modules/core/tools/tcc.lua @@ -171,7 +171,7 @@ function _compargv1(self, sourcefile, objectfile, flags) local program = self:program() if ccache then - -- parse the filename and arguments, .e.g "xcrun -sdk macosx clang" + -- parse the filename and arguments, e.g. "xcrun -sdk macosx clang" if not os.isexec(program) then argv = table.join(program:split("%s"), argv) else diff --git a/xmake/modules/detect/sdks/find_android_sdk.lua b/xmake/modules/detect/sdks/find_android_sdk.lua index e7af7114f..7c6cb5528 100644 --- a/xmake/modules/detect/sdks/find_android_sdk.lua +++ b/xmake/modules/detect/sdks/find_android_sdk.lua @@ -80,7 +80,7 @@ end -- @param sdkdir the android sdk directory -- @param opt the argument options, e.g. {force = true, build_toolver = "28.0.3"} -- --- @return the sdk toolchains. .e.g {sdkdir = .., build_toolver = "28.0.3"} +-- @return the sdk toolchains. e.g. {sdkdir = .., build_toolver = "28.0.3"} -- -- @code -- diff --git a/xmake/modules/detect/sdks/find_cross_toolchain.lua b/xmake/modules/detect/sdks/find_cross_toolchain.lua index f19ba0f8b..e925def18 100644 --- a/xmake/modules/detect/sdks/find_cross_toolchain.lua +++ b/xmake/modules/detect/sdks/find_cross_toolchain.lua @@ -51,9 +51,9 @@ end -- -- @param sdkdir the root sdk directory of cross toolchain -- @param opt the argument options --- .e.g {bindir = .., cross = ..} +-- e.g. {bindir = .., cross = ..} -- --- @return the toolchain .e.g {sdkdir = .., bindir = .., cross = ..} +-- @return the toolchain e.g. {sdkdir = .., bindir = .., cross = ..} -- -- @code -- diff --git a/xmake/modules/detect/sdks/find_cuda.lua b/xmake/modules/detect/sdks/find_cuda.lua index 54b8f21cf..fb69be138 100644 --- a/xmake/modules/detect/sdks/find_cuda.lua +++ b/xmake/modules/detect/sdks/find_cuda.lua @@ -93,7 +93,7 @@ end -- @param sdkdir the cuda sdk directory -- @param opt the argument options -- --- @return the cuda sdk toolchains. .e.g {sdkdir = ..., bindir = .., linkdirs = ..., includedirs = ..., .. } +-- @return the cuda sdk toolchains. e.g. {sdkdir = ..., bindir = .., linkdirs = ..., includedirs = ..., .. } -- -- @code -- diff --git a/xmake/modules/detect/sdks/find_dotnet.lua b/xmake/modules/detect/sdks/find_dotnet.lua index dd9362fcb..fe81ba099 100644 --- a/xmake/modules/detect/sdks/find_dotnet.lua +++ b/xmake/modules/detect/sdks/find_dotnet.lua @@ -81,9 +81,9 @@ end -- find dotnet toolchains -- -- @param sdkdir the dotnet directory --- @param opt the argument options, .e.g {verbose = true, force = false, version = "5.9.1"} +-- @param opt the argument options, e.g. {verbose = true, force = false, version = "5.9.1"} -- --- @return the dotnet toolchains. .e.g {sdkver = ..., sdkdir = ..., bindir = .., libdir = ..., includedir = ..., .. } +-- @return the dotnet toolchains. e.g. {sdkver = ..., sdkdir = ..., bindir = .., libdir = ..., includedir = ..., .. } -- -- @code -- diff --git a/xmake/modules/detect/sdks/find_mingw.lua b/xmake/modules/detect/sdks/find_mingw.lua index 5f356e957..df0a69c71 100644 --- a/xmake/modules/detect/sdks/find_mingw.lua +++ b/xmake/modules/detect/sdks/find_mingw.lua @@ -71,9 +71,9 @@ end -- -- @param sdkdir the mingw directory -- @param opt the argument options --- .e.g {verbose = true, force = false, bindir = .., cross = ...} +-- e.g. {verbose = true, force = false, bindir = .., cross = ...} -- --- @return the mingw toolchains. .e.g {sdkdir = .., bindir = .., cross = ..} +-- @return the mingw toolchains. e.g. {sdkdir = .., bindir = .., cross = ..} -- -- @code -- diff --git a/xmake/modules/detect/sdks/find_ndk.lua b/xmake/modules/detect/sdks/find_ndk.lua index 81269cc37..7dafc5cf4 100644 --- a/xmake/modules/detect/sdks/find_ndk.lua +++ b/xmake/modules/detect/sdks/find_ndk.lua @@ -141,9 +141,9 @@ end -- -- @param sdkdir the ndk directory -- @param opt the argument options --- .e.g {arch = "[armv5te|armv6|armv7-a|armv8-a|arm64-v8a]", verbose = true, force = false, sdkver = 19, toolchains_ver = "4.9"} +-- e.g. {arch = "[armv5te|armv6|armv7-a|armv8-a|arm64-v8a]", verbose = true, force = false, sdkver = 19, toolchains_ver = "4.9"} -- --- @return the ndk toolchains. .e.g {bindir = .., cross = ..} +-- @return the ndk toolchains. e.g. {bindir = .., cross = ..} -- -- @code -- diff --git a/xmake/modules/detect/sdks/find_qt.lua b/xmake/modules/detect/sdks/find_qt.lua index 6ab39b254..56a3485cc 100644 --- a/xmake/modules/detect/sdks/find_qt.lua +++ b/xmake/modules/detect/sdks/find_qt.lua @@ -87,7 +87,7 @@ function _find_sdkdir(sdkdir, sdkver) end) end - -- add root logical drive pates, .e.g C:/Qt/Qtx.x.x, D:/Qtx.x.x .. + -- add root logical drive pates, e.g. C:/Qt/Qtx.x.x, D:/Qtx.x.x .. for idx, drive in ipairs(winos.logical_drives()) do if idx < 5 then table.insert(pathes, path.join(drive, "Qt", "Qt*")) @@ -137,9 +137,9 @@ end -- find qt sdk toolchains -- -- @param sdkdir the qt sdk directory --- @param opt the argument options, .e.g {verbose = true, force = false, version = "5.9.1"} +-- @param opt the argument options, e.g. {verbose = true, force = false, version = "5.9.1"} -- --- @return the qt sdk toolchains. .e.g {sdkver = ..., sdkdir = ..., bindir = .., linkdirs = ..., includedirs = ..., .. } +-- @return the qt sdk toolchains. e.g. {sdkver = ..., sdkdir = ..., bindir = .., linkdirs = ..., includedirs = ..., .. } -- -- @code -- diff --git a/xmake/modules/detect/sdks/find_vcpkgdir.lua b/xmake/modules/detect/sdks/find_vcpkgdir.lua index 9cc7c390c..050fa3ee8 100644 --- a/xmake/modules/detect/sdks/find_vcpkgdir.lua +++ b/xmake/modules/detect/sdks/find_vcpkgdir.lua @@ -56,7 +56,7 @@ end -- find vcpkg directory -- -- @param sdkdir the vcpkg directory --- @param opt the argument options, .e.g {verbose = true, force = false} +-- @param opt the argument options, e.g. {verbose = true, force = false} -- -- @return the vcpkg directory -- diff --git a/xmake/modules/detect/sdks/find_vstudio.lua b/xmake/modules/detect/sdks/find_vstudio.lua index cbc7d4f02..884fe2973 100755 --- a/xmake/modules/detect/sdks/find_vstudio.lua +++ b/xmake/modules/detect/sdks/find_vstudio.lua @@ -114,7 +114,7 @@ end -- find vstudio environment -- --- @param opt the options, .e.g {vcvars_ver = 14.0, sdkver = "10.0.15063.0"} +-- @param opt the options, e.g. {vcvars_ver = 14.0, sdkver = "10.0.15063.0"} -- -- @return { 2008 = {version = "9.0", vcvarsall = {x86 = {path = .., lib = .., include = ..}}} -- , 2017 = {version = "15.0", vcvarsall = {x64 = {path = .., lib = ..}}}} diff --git a/xmake/modules/detect/sdks/find_wdk.lua b/xmake/modules/detect/sdks/find_wdk.lua index e19befd02..e857e807f 100644 --- a/xmake/modules/detect/sdks/find_wdk.lua +++ b/xmake/modules/detect/sdks/find_wdk.lua @@ -144,9 +144,9 @@ end -- find WDK toolchains -- -- @param sdkdir the WDK directory --- @param opt the argument options, .e.g {verbose = true, force = false, version = "5.9.1"} +-- @param opt the argument options, e.g. {verbose = true, force = false, version = "5.9.1"} -- --- @return the WDK toolchains. .e.g {sdkver = ..., sdkdir = ..., bindir = .., libdir = ..., includedir = ..., .. } +-- @return the WDK toolchains. e.g. {sdkver = ..., sdkdir = ..., bindir = .., libdir = ..., includedir = ..., .. } -- -- @code -- diff --git a/xmake/modules/detect/sdks/find_xcode.lua b/xmake/modules/detect/sdks/find_xcode.lua index 7a3dd68d0..46f313ba1 100644 --- a/xmake/modules/detect/sdks/find_xcode.lua +++ b/xmake/modules/detect/sdks/find_xcode.lua @@ -86,9 +86,9 @@ end -- -- @param sdkdir the xcode directory -- @param opt the argument options --- .e.g {verbose = true, force = false, sdkver = 19, toolchains_ver = "4.9"} +-- e.g. {verbose = true, force = false, sdkver = 19, toolchains_ver = "4.9"} -- --- @return the xcode toolchain. .e.g {bindir = .., cross = ..} +-- @return the xcode toolchain. e.g. {bindir = .., cross = ..} -- -- @code -- diff --git a/xmake/modules/detect/tools/ar/has_flags.lua b/xmake/modules/detect/tools/ar/has_flags.lua index 98db6705b..97c913762 100644 --- a/xmake/modules/detect/tools/ar/has_flags.lua +++ b/xmake/modules/detect/tools/ar/has_flags.lua @@ -75,7 +75,7 @@ end -- has_flags(flags)? -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} -- -- @return true or false -- diff --git a/xmake/modules/detect/tools/cl/features.lua b/xmake/modules/detect/tools/cl/features.lua index 5058c6587..f43c9f789 100644 --- a/xmake/modules/detect/tools/cl/features.lua +++ b/xmake/modules/detect/tools/cl/features.lua @@ -123,7 +123,7 @@ end -- get features -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", flags = {}} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", flags = {}} -- -- @return the features -- diff --git a/xmake/modules/detect/tools/cl/has_flags.lua b/xmake/modules/detect/tools/cl/has_flags.lua index 7009027fb..2a1fff437 100644 --- a/xmake/modules/detect/tools/cl/has_flags.lua +++ b/xmake/modules/detect/tools/cl/has_flags.lua @@ -84,7 +84,7 @@ end -- has_flags(flags)? -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} -- -- @return true or false -- diff --git a/xmake/modules/detect/tools/clang/features.lua b/xmake/modules/detect/tools/clang/features.lua index c53fb2581..f946cd9a9 100644 --- a/xmake/modules/detect/tools/clang/features.lua +++ b/xmake/modules/detect/tools/clang/features.lua @@ -25,7 +25,7 @@ import("cxxfeatures") -- get features -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", flags = {}} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", flags = {}} -- -- @return the features -- diff --git a/xmake/modules/detect/tools/dmd/has_flags.lua b/xmake/modules/detect/tools/dmd/has_flags.lua index b1c3db206..d669169c5 100644 --- a/xmake/modules/detect/tools/dmd/has_flags.lua +++ b/xmake/modules/detect/tools/dmd/has_flags.lua @@ -104,7 +104,7 @@ end -- has_flags(flags)? -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} -- -- @return true or false -- diff --git a/xmake/modules/detect/tools/find_7z.lua b/xmake/modules/detect/tools/find_7z.lua index 66dcf4707..1d6f7e937 100644 --- a/xmake/modules/detect/tools/find_7z.lua +++ b/xmake/modules/detect/tools/find_7z.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find 7z -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_apt.lua b/xmake/modules/detect/tools/find_apt.lua index 8f3e91448..e4943dbba 100644 --- a/xmake/modules/detect/tools/find_apt.lua +++ b/xmake/modules/detect/tools/find_apt.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find apt -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_ar.lua b/xmake/modules/detect/tools/find_ar.lua index ca96f3c43..9394c956e 100644 --- a/xmake/modules/detect/tools/find_ar.lua +++ b/xmake/modules/detect/tools/find_ar.lua @@ -45,7 +45,7 @@ end -- find ar -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_bison.lua b/xmake/modules/detect/tools/find_bison.lua index 89ff96138..a96360a08 100644 --- a/xmake/modules/detect/tools/find_bison.lua +++ b/xmake/modules/detect/tools/find_bison.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find bison -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_brew.lua b/xmake/modules/detect/tools/find_brew.lua index d938d27c5..54dac4af3 100644 --- a/xmake/modules/detect/tools/find_brew.lua +++ b/xmake/modules/detect/tools/find_brew.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find brew -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_ccache.lua b/xmake/modules/detect/tools/find_ccache.lua index 40082d282..0242ef37a 100644 --- a/xmake/modules/detect/tools/find_ccache.lua +++ b/xmake/modules/detect/tools/find_ccache.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find ccache -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_cl.lua b/xmake/modules/detect/tools/find_cl.lua index 7acd78e8b..f50f5f0bd 100644 --- a/xmake/modules/detect/tools/find_cl.lua +++ b/xmake/modules/detect/tools/find_cl.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find cl -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_clang.lua b/xmake/modules/detect/tools/find_clang.lua index f91b6b4a5..5dbbc5630 100644 --- a/xmake/modules/detect/tools/find_clang.lua +++ b/xmake/modules/detect/tools/find_clang.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find clang -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_clangxx.lua b/xmake/modules/detect/tools/find_clangxx.lua index 9cf7c7daf..4c4692c71 100644 --- a/xmake/modules/detect/tools/find_clangxx.lua +++ b/xmake/modules/detect/tools/find_clangxx.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find clang++ -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_clib.lua b/xmake/modules/detect/tools/find_clib.lua index 2464ec248..858ecd00a 100644 --- a/xmake/modules/detect/tools/find_clib.lua +++ b/xmake/modules/detect/tools/find_clib.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find clib -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_cmake.lua b/xmake/modules/detect/tools/find_cmake.lua index 7e35a0fba..668df5653 100644 --- a/xmake/modules/detect/tools/find_cmake.lua +++ b/xmake/modules/detect/tools/find_cmake.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find cmake -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_conan.lua b/xmake/modules/detect/tools/find_conan.lua index f11832484..0e8634c8d 100644 --- a/xmake/modules/detect/tools/find_conan.lua +++ b/xmake/modules/detect/tools/find_conan.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find conan -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_cparser.lua b/xmake/modules/detect/tools/find_cparser.lua index 0d96b620d..2bd422a31 100644 --- a/xmake/modules/detect/tools/find_cparser.lua +++ b/xmake/modules/detect/tools/find_cparser.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find cparser -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_cpp.lua b/xmake/modules/detect/tools/find_cpp.lua index 35c1a1e82..35916e0ca 100644 --- a/xmake/modules/detect/tools/find_cpp.lua +++ b/xmake/modules/detect/tools/find_cpp.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find cpp -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_cudagdb.lua b/xmake/modules/detect/tools/find_cudagdb.lua index 15d501ba4..aacc6635f 100644 --- a/xmake/modules/detect/tools/find_cudagdb.lua +++ b/xmake/modules/detect/tools/find_cudagdb.lua @@ -23,7 +23,7 @@ import("private.detect.find_cudatool") -- find cudagdb -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_cudamemcheck.lua b/xmake/modules/detect/tools/find_cudamemcheck.lua index 4c7de7469..d55ac9318 100644 --- a/xmake/modules/detect/tools/find_cudamemcheck.lua +++ b/xmake/modules/detect/tools/find_cudamemcheck.lua @@ -23,7 +23,7 @@ import("private.detect.find_cudatool") -- find cudamemcheck -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_curl.lua b/xmake/modules/detect/tools/find_curl.lua index b5c13b40c..70ad984c8 100644 --- a/xmake/modules/detect/tools/find_curl.lua +++ b/xmake/modules/detect/tools/find_curl.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find curl -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_dmd.lua b/xmake/modules/detect/tools/find_dmd.lua index 2ee8191aa..c8c35346a 100644 --- a/xmake/modules/detect/tools/find_dmd.lua +++ b/xmake/modules/detect/tools/find_dmd.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find dmd -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_doxygen.lua b/xmake/modules/detect/tools/find_doxygen.lua index 202938115..275d1ba3c 100644 --- a/xmake/modules/detect/tools/find_doxygen.lua +++ b/xmake/modules/detect/tools/find_doxygen.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find doxygen -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_fasm.lua b/xmake/modules/detect/tools/find_fasm.lua index 2856a176e..08c01061d 100644 --- a/xmake/modules/detect/tools/find_fasm.lua +++ b/xmake/modules/detect/tools/find_fasm.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find fasm -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_flex.lua b/xmake/modules/detect/tools/find_flex.lua index f95aea27b..6eb3bdf41 100644 --- a/xmake/modules/detect/tools/find_flex.lua +++ b/xmake/modules/detect/tools/find_flex.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find flex -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_gcc.lua b/xmake/modules/detect/tools/find_gcc.lua index 9dc70c0ef..f5e5475f9 100644 --- a/xmake/modules/detect/tools/find_gcc.lua +++ b/xmake/modules/detect/tools/find_gcc.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find gcc -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_gccgo.lua b/xmake/modules/detect/tools/find_gccgo.lua index d34f18eb9..c61eb5ef9 100644 --- a/xmake/modules/detect/tools/find_gccgo.lua +++ b/xmake/modules/detect/tools/find_gccgo.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find gccgo -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_gdb.lua b/xmake/modules/detect/tools/find_gdb.lua index 9d9936db9..cc13ad52d 100644 --- a/xmake/modules/detect/tools/find_gdb.lua +++ b/xmake/modules/detect/tools/find_gdb.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find gdb -- --- @param opt the argument options, .e.g {version = true, program="/usr/bin/gdb"} +-- @param opt the argument options, e.g. {version = true, program="/usr/bin/gdb"} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_gdc.lua b/xmake/modules/detect/tools/find_gdc.lua index 65d10543f..852d3eb11 100644 --- a/xmake/modules/detect/tools/find_gdc.lua +++ b/xmake/modules/detect/tools/find_gdc.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find gdc -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_git.lua b/xmake/modules/detect/tools/find_git.lua index 0b1961fdf..58f0d246b 100644 --- a/xmake/modules/detect/tools/find_git.lua +++ b/xmake/modules/detect/tools/find_git.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find git -- --- @param opt the arguments, .e.g {version = true} +-- @param opt the arguments, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_go.lua b/xmake/modules/detect/tools/find_go.lua index 318aa8b27..e547f7c54 100644 --- a/xmake/modules/detect/tools/find_go.lua +++ b/xmake/modules/detect/tools/find_go.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find go -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_gxx.lua b/xmake/modules/detect/tools/find_gxx.lua index 6ff65dc42..1257c4a48 100644 --- a/xmake/modules/detect/tools/find_gxx.lua +++ b/xmake/modules/detect/tools/find_gxx.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find g++ -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_gzip.lua b/xmake/modules/detect/tools/find_gzip.lua index 6f96f23a4..a55db6eb2 100644 --- a/xmake/modules/detect/tools/find_gzip.lua +++ b/xmake/modules/detect/tools/find_gzip.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find gzip -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_ldc2.lua b/xmake/modules/detect/tools/find_ldc2.lua index 19e1b8753..142bfe4ec 100644 --- a/xmake/modules/detect/tools/find_ldc2.lua +++ b/xmake/modules/detect/tools/find_ldc2.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find ldc2 -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_lex.lua b/xmake/modules/detect/tools/find_lex.lua index c127cf7b6..6136028ad 100644 --- a/xmake/modules/detect/tools/find_lex.lua +++ b/xmake/modules/detect/tools/find_lex.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find lex -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_lib.lua b/xmake/modules/detect/tools/find_lib.lua index 522b72afe..053356b70 100644 --- a/xmake/modules/detect/tools/find_lib.lua +++ b/xmake/modules/detect/tools/find_lib.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find lib -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_link.lua b/xmake/modules/detect/tools/find_link.lua index 310190c0d..2b6ebb71e 100644 --- a/xmake/modules/detect/tools/find_link.lua +++ b/xmake/modules/detect/tools/find_link.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find link -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_lipo.lua b/xmake/modules/detect/tools/find_lipo.lua index fe3815ae3..36ae01888 100644 --- a/xmake/modules/detect/tools/find_lipo.lua +++ b/xmake/modules/detect/tools/find_lipo.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find lipo -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_lldb.lua b/xmake/modules/detect/tools/find_lldb.lua index 9e7919ce9..07b66111a 100644 --- a/xmake/modules/detect/tools/find_lldb.lua +++ b/xmake/modules/detect/tools/find_lldb.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find lldb -- --- @param opt the argument options, .e.g {version = true, program="/usr/bin/lldb"} +-- @param opt the argument options, e.g. {version = true, program="/usr/bin/lldb"} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_llvm_ar.lua b/xmake/modules/detect/tools/find_llvm_ar.lua index 415c85085..f90d84a86 100644 --- a/xmake/modules/detect/tools/find_llvm_ar.lua +++ b/xmake/modules/detect/tools/find_llvm_ar.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find llvm-ar -- --- @param opt the argument options, .e.g {version = true, program = "c:\xxx\llvm_ar.exe"} +-- @param opt the argument options, e.g. {version = true, program = "c:\xxx\llvm_ar.exe"} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_llvm_rc.lua b/xmake/modules/detect/tools/find_llvm_rc.lua index edf1d38d1..1a71db6b1 100644 --- a/xmake/modules/detect/tools/find_llvm_rc.lua +++ b/xmake/modules/detect/tools/find_llvm_rc.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find llvm-rc -- --- @param opt the argument options, .e.g {version = true, program = "c:\xxx\llvm_rc.exe"} +-- @param opt the argument options, e.g. {version = true, program = "c:\xxx\llvm_rc.exe"} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_lua.lua b/xmake/modules/detect/tools/find_lua.lua index 113c8f477..b4fc11691 100644 --- a/xmake/modules/detect/tools/find_lua.lua +++ b/xmake/modules/detect/tools/find_lua.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find lua -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_luajit.lua b/xmake/modules/detect/tools/find_luajit.lua index ca1661a49..59cf26c85 100644 --- a/xmake/modules/detect/tools/find_luajit.lua +++ b/xmake/modules/detect/tools/find_luajit.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find lua -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_ml.lua b/xmake/modules/detect/tools/find_ml.lua index 94b3be7e3..575e89e21 100644 --- a/xmake/modules/detect/tools/find_ml.lua +++ b/xmake/modules/detect/tools/find_ml.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find ml -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_ml64.lua b/xmake/modules/detect/tools/find_ml64.lua index 35f583952..fae86a1b3 100644 --- a/xmake/modules/detect/tools/find_ml64.lua +++ b/xmake/modules/detect/tools/find_ml64.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find ml64 -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_nvcc.lua b/xmake/modules/detect/tools/find_nvcc.lua index 68db9fef5..38f35497d 100644 --- a/xmake/modules/detect/tools/find_nvcc.lua +++ b/xmake/modules/detect/tools/find_nvcc.lua @@ -23,7 +23,7 @@ import("private.detect.find_cudatool") -- find nvcc -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_ollydbg.lua b/xmake/modules/detect/tools/find_ollydbg.lua index 0037ff4fc..4cc26cd74 100644 --- a/xmake/modules/detect/tools/find_ollydbg.lua +++ b/xmake/modules/detect/tools/find_ollydbg.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find ollydbg -- --- @param opt the argument options, .e.g {version = true, program = "c:\xxx\ollydbg.exe"} +-- @param opt the argument options, e.g. {version = true, program = "c:\xxx\ollydbg.exe"} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_pacman.lua b/xmake/modules/detect/tools/find_pacman.lua index 9b70adbb0..9b8295c8f 100644 --- a/xmake/modules/detect/tools/find_pacman.lua +++ b/xmake/modules/detect/tools/find_pacman.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find pacman -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_patch.lua b/xmake/modules/detect/tools/find_patch.lua index d291ee254..d5e6402b8 100644 --- a/xmake/modules/detect/tools/find_patch.lua +++ b/xmake/modules/detect/tools/find_patch.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find lua -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_pkg_config.lua b/xmake/modules/detect/tools/find_pkg_config.lua index 1893381bd..c143ebf73 100644 --- a/xmake/modules/detect/tools/find_pkg_config.lua +++ b/xmake/modules/detect/tools/find_pkg_config.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find pkg_config -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_python.lua b/xmake/modules/detect/tools/find_python.lua index c732391ff..8e6257580 100644 --- a/xmake/modules/detect/tools/find_python.lua +++ b/xmake/modules/detect/tools/find_python.lua @@ -26,7 +26,7 @@ import("detect.tools.find_python3") -- find python -- --- @param opt the arguments, .e.g {version = true} +-- @param opt the arguments, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_python2.lua b/xmake/modules/detect/tools/find_python2.lua index 278631089..f07a008d3 100644 --- a/xmake/modules/detect/tools/find_python2.lua +++ b/xmake/modules/detect/tools/find_python2.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find python -- --- @param opt the arguments, .e.g {version = true} +-- @param opt the arguments, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_python3.lua b/xmake/modules/detect/tools/find_python3.lua index b7ff3fb0f..2fb0866f0 100644 --- a/xmake/modules/detect/tools/find_python3.lua +++ b/xmake/modules/detect/tools/find_python3.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find python -- --- @param opt the arguments, .e.g {version = true} +-- @param opt the arguments, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_ranlib.lua b/xmake/modules/detect/tools/find_ranlib.lua index c20b14bf1..3e8b0d602 100644 --- a/xmake/modules/detect/tools/find_ranlib.lua +++ b/xmake/modules/detect/tools/find_ranlib.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find ranlib -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_rc.lua b/xmake/modules/detect/tools/find_rc.lua index c7c68a42d..cadf9fc6e 100644 --- a/xmake/modules/detect/tools/find_rc.lua +++ b/xmake/modules/detect/tools/find_rc.lua @@ -25,7 +25,7 @@ import("lib.detect.find_programver") -- find rc -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- @@ -50,7 +50,7 @@ function main(opt) -- -- patch sdk bin directory to path environment -- - -- .e.g C:\Program Files (x86)\Windows Kits\10\bin\10.0.17134.0\x64 + -- e.g. C:\Program Files (x86)\Windows Kits\10\bin\10.0.17134.0\x64 -- local arch = opt.arch or config.arch() or os.arch() local vcvarsall = config.get("__vcvarsall") diff --git a/xmake/modules/detect/tools/find_rustc.lua b/xmake/modules/detect/tools/find_rustc.lua index 3b59052ec..48f3bdb15 100644 --- a/xmake/modules/detect/tools/find_rustc.lua +++ b/xmake/modules/detect/tools/find_rustc.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find rustc -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_sudo.lua b/xmake/modules/detect/tools/find_sudo.lua index 5779eab22..a15cdc4fb 100644 --- a/xmake/modules/detect/tools/find_sudo.lua +++ b/xmake/modules/detect/tools/find_sudo.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find sudo -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_swiftc.lua b/xmake/modules/detect/tools/find_swiftc.lua index c4811d4f7..2197c3b73 100644 --- a/xmake/modules/detect/tools/find_swiftc.lua +++ b/xmake/modules/detect/tools/find_swiftc.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find swiftc -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_tar.lua b/xmake/modules/detect/tools/find_tar.lua index 2a99f714f..58747345c 100644 --- a/xmake/modules/detect/tools/find_tar.lua +++ b/xmake/modules/detect/tools/find_tar.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find tar -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_tcc.lua b/xmake/modules/detect/tools/find_tcc.lua index 6617f749d..55dcf1fa0 100644 --- a/xmake/modules/detect/tools/find_tcc.lua +++ b/xmake/modules/detect/tools/find_tcc.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find tcc -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_unzip.lua b/xmake/modules/detect/tools/find_unzip.lua index 6b95a8fe2..b179cf01e 100644 --- a/xmake/modules/detect/tools/find_unzip.lua +++ b/xmake/modules/detect/tools/find_unzip.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find unzip -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_vsjitdebugger.lua b/xmake/modules/detect/tools/find_vsjitdebugger.lua index af29c5a2e..7f5c647af 100644 --- a/xmake/modules/detect/tools/find_vsjitdebugger.lua +++ b/xmake/modules/detect/tools/find_vsjitdebugger.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find vsjitdebugger -- --- @param opt the argument options, .e.g {version = true, program = "c:\xxx\vsjitdebugger.exe"} +-- @param opt the argument options, e.g. {version = true, program = "c:\xxx\vsjitdebugger.exe"} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_vswhere.lua b/xmake/modules/detect/tools/find_vswhere.lua index 08b211f5a..bb00be6f7 100644 --- a/xmake/modules/detect/tools/find_vswhere.lua +++ b/xmake/modules/detect/tools/find_vswhere.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find vswhere -- --- @param opt the argument options, .e.g {version = true, program = "c:\xxx\vswhere.exe"} +-- @param opt the argument options, e.g. {version = true, program = "c:\xxx\vswhere.exe"} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_wget.lua b/xmake/modules/detect/tools/find_wget.lua index 29f956625..0056f136a 100644 --- a/xmake/modules/detect/tools/find_wget.lua +++ b/xmake/modules/detect/tools/find_wget.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find wget -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_windbg.lua b/xmake/modules/detect/tools/find_windbg.lua index 516e2dadb..3c7e9c00d 100644 --- a/xmake/modules/detect/tools/find_windbg.lua +++ b/xmake/modules/detect/tools/find_windbg.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find windbg -- --- @param opt the argument options, .e.g {version = true, program = "c:\xxx\windbg.exe"} +-- @param opt the argument options, e.g. {version = true, program = "c:\xxx\windbg.exe"} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_windres.lua b/xmake/modules/detect/tools/find_windres.lua index c7e329789..8a215424b 100644 --- a/xmake/modules/detect/tools/find_windres.lua +++ b/xmake/modules/detect/tools/find_windres.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find windres -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_x64dbg.lua b/xmake/modules/detect/tools/find_x64dbg.lua index f6c113e35..46a3a0551 100644 --- a/xmake/modules/detect/tools/find_x64dbg.lua +++ b/xmake/modules/detect/tools/find_x64dbg.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find x64dbg -- --- @param opt the argument options, .e.g {version = true, program = "c:\xxx\x64dbg.exe"} +-- @param opt the argument options, e.g. {version = true, program = "c:\xxx\x64dbg.exe"} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_xz.lua b/xmake/modules/detect/tools/find_xz.lua index 1f886eac4..0bdf8e553 100644 --- a/xmake/modules/detect/tools/find_xz.lua +++ b/xmake/modules/detect/tools/find_xz.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find xz -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_yacc.lua b/xmake/modules/detect/tools/find_yacc.lua index 45853b2bb..58c805032 100644 --- a/xmake/modules/detect/tools/find_yacc.lua +++ b/xmake/modules/detect/tools/find_yacc.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find yacc -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_yasm.lua b/xmake/modules/detect/tools/find_yasm.lua index 21c7e841e..3e4a6e292 100644 --- a/xmake/modules/detect/tools/find_yasm.lua +++ b/xmake/modules/detect/tools/find_yasm.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find yasm -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_yum.lua b/xmake/modules/detect/tools/find_yum.lua index 7e54ed99a..ae2359916 100644 --- a/xmake/modules/detect/tools/find_yum.lua +++ b/xmake/modules/detect/tools/find_yum.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find yum -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/find_zip.lua b/xmake/modules/detect/tools/find_zip.lua index 97ea73598..7a22fa0b2 100644 --- a/xmake/modules/detect/tools/find_zip.lua +++ b/xmake/modules/detect/tools/find_zip.lua @@ -24,7 +24,7 @@ import("lib.detect.find_programver") -- find zip -- --- @param opt the argument options, .e.g {version = true} +-- @param opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/detect/tools/gcc/features.lua b/xmake/modules/detect/tools/gcc/features.lua index 319b1e93f..11070b305 100644 --- a/xmake/modules/detect/tools/gcc/features.lua +++ b/xmake/modules/detect/tools/gcc/features.lua @@ -118,7 +118,7 @@ end -- get features -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", flags = {}} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", flags = {}} -- -- @return the features -- diff --git a/xmake/modules/detect/tools/gcc/has_flags.lua b/xmake/modules/detect/tools/gcc/has_flags.lua index ea9a8f200..51bb93b51 100644 --- a/xmake/modules/detect/tools/gcc/has_flags.lua +++ b/xmake/modules/detect/tools/gcc/has_flags.lua @@ -115,7 +115,7 @@ end -- has_flags(flags)? -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|mm|mxx]"} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|mm|mxx]"} -- -- @return true or false -- diff --git a/xmake/modules/detect/tools/go/has_flags.lua b/xmake/modules/detect/tools/go/has_flags.lua index 21ec732fd..d79c415e3 100644 --- a/xmake/modules/detect/tools/go/has_flags.lua +++ b/xmake/modules/detect/tools/go/has_flags.lua @@ -115,7 +115,7 @@ end -- has_flags(flags)? -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|mm|mxx]"} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|mm|mxx]"} -- -- @return true or false -- diff --git a/xmake/modules/detect/tools/link/has_flags.lua b/xmake/modules/detect/tools/link/has_flags.lua index d2f170ab9..066ed813e 100644 --- a/xmake/modules/detect/tools/link/has_flags.lua +++ b/xmake/modules/detect/tools/link/has_flags.lua @@ -121,7 +121,7 @@ end -- has_flags(flags)? -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} -- -- @return true or false -- diff --git a/xmake/modules/detect/tools/ml/has_flags.lua b/xmake/modules/detect/tools/ml/has_flags.lua index 2719c2b37..7d782ca66 100644 --- a/xmake/modules/detect/tools/ml/has_flags.lua +++ b/xmake/modules/detect/tools/ml/has_flags.lua @@ -84,7 +84,7 @@ end -- has_flags(flags)? -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} -- -- @return true or false -- diff --git a/xmake/modules/detect/tools/nvcc/has_flags.lua b/xmake/modules/detect/tools/nvcc/has_flags.lua index 192402fd8..40272756f 100644 --- a/xmake/modules/detect/tools/nvcc/has_flags.lua +++ b/xmake/modules/detect/tools/nvcc/has_flags.lua @@ -122,7 +122,7 @@ end -- has_flags(flags)? -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", toolkind = "cu"} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", toolkind = "cu"} -- -- @return true or false -- diff --git a/xmake/modules/detect/tools/rustc/has_flags.lua b/xmake/modules/detect/tools/rustc/has_flags.lua index d98ab055d..082b3d3a8 100644 --- a/xmake/modules/detect/tools/rustc/has_flags.lua +++ b/xmake/modules/detect/tools/rustc/has_flags.lua @@ -90,7 +90,7 @@ end -- has_flags(flags)? -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} -- -- @return true or false -- diff --git a/xmake/modules/detect/tools/swiftc/has_flags.lua b/xmake/modules/detect/tools/swiftc/has_flags.lua index 2983ea543..84e0c48dd 100644 --- a/xmake/modules/detect/tools/swiftc/has_flags.lua +++ b/xmake/modules/detect/tools/swiftc/has_flags.lua @@ -90,7 +90,7 @@ end -- has_flags(flags)? -- --- @param opt the argument options, .e.g {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} +-- @param opt the argument options, e.g. {toolname = "", program = "", programver = "", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]"} -- -- @return true or false -- diff --git a/xmake/modules/devel/debugger/run.lua b/xmake/modules/devel/debugger/run.lua index 5e75c0b9d..2c08f1f9a 100644 --- a/xmake/modules/devel/debugger/run.lua +++ b/xmake/modules/devel/debugger/run.lua @@ -81,7 +81,7 @@ function _run_lldb(program, argv) return false end - -- attempt to split name, .e.g xcrun -sdk macosx lldb + -- attempt to split name, e.g. xcrun -sdk macosx lldb local names = lldb:split("%s") -- patch arguments diff --git a/xmake/modules/lib/detect/check_csnippets.lua b/xmake/modules/lib/detect/check_csnippets.lua index 364b09f51..acaf6f7e8 100644 --- a/xmake/modules/lib/detect/check_csnippets.lua +++ b/xmake/modules/lib/detect/check_csnippets.lua @@ -25,7 +25,7 @@ import("lib.detect.check_cxsnippets") -- -- @param snippets the snippets -- @param opt the argument options --- .e.g +-- e.g. -- { verbose = false, target = [target|option] -- , types = {"wchar_t", "char*"}, includes = "stdio.h", funcs = {"sigsetjmp", "sigsetjmp((void*)0, 0)"} -- , configs = {defines = "xx", cxflags = ""}} diff --git a/xmake/modules/lib/detect/check_cxsnippets.lua b/xmake/modules/lib/detect/check_cxsnippets.lua index dd2bf6cd1..6615c477c 100644 --- a/xmake/modules/lib/detect/check_cxsnippets.lua +++ b/xmake/modules/lib/detect/check_cxsnippets.lua @@ -113,7 +113,7 @@ end -- -- @param snippets the snippets -- @param opt the argument options --- .e.g +-- e.g. -- { verbose = false, target = [target|option], sourcekind = "[cc|cxx]" -- , types = {"wchar_t", "char*"}, includes = "stdio.h", funcs = {"sigsetjmp", "sigsetjmp((void*)0, 0)"} -- , configs = {defines = "xx", cxflags = ""}} diff --git a/xmake/modules/lib/detect/check_cxxsnippets.lua b/xmake/modules/lib/detect/check_cxxsnippets.lua index 06d9f6c4b..e0301ebc4 100644 --- a/xmake/modules/lib/detect/check_cxxsnippets.lua +++ b/xmake/modules/lib/detect/check_cxxsnippets.lua @@ -25,7 +25,7 @@ import("lib.detect.check_cxsnippets") -- -- @param snippets the snippets -- @param opt the argument options --- .e.g +-- e.g. -- { verbose = false, target = [target|option] -- , types = {"wchar_t", "char*"}, includes = "stdio.h", funcs = {"sigsetjmp", "sigsetjmp((void*)0, 0)"} -- , configs = {defines = "xx", cxflags = ""}} diff --git a/xmake/modules/lib/detect/features.lua b/xmake/modules/lib/detect/features.lua index 24534787f..3a9806b5e 100644 --- a/xmake/modules/lib/detect/features.lua +++ b/xmake/modules/lib/detect/features.lua @@ -24,7 +24,7 @@ import("lib.detect.find_tool") -- get all features of the current tool -- -- @param name the tool name --- @param opt the argument options, .e.g {program = "", flags = {}} +-- @param opt the argument options, e.g. {program = "", flags = {}} -- -- @return the features dictionary -- @@ -56,7 +56,7 @@ function main(name, opt) _g._RESULTS = _g._RESULTS or {} local results = _g._RESULTS - -- @note avoid detect the same program in the same time if running in the coroutine (.e.g ccache) + -- @note avoid detect the same program in the same time if running in the coroutine (e.g. ccache) local coroutine_running = coroutine.running() if coroutine_running then while _g._checking ~= nil and _g._checking == key do diff --git a/xmake/modules/lib/detect/find_tool.lua b/xmake/modules/lib/detect/find_tool.lua index d53e797b2..831884384 100644 --- a/xmake/modules/lib/detect/find_tool.lua +++ b/xmake/modules/lib/detect/find_tool.lua @@ -39,7 +39,7 @@ end -- find tool -- -- @param name the tool name --- @param opt the options, .e.g {program = "xcrun -sdk macosx clang", pathes = {"/usr/bin"}, +-- @param opt the options, e.g. {program = "xcrun -sdk macosx clang", pathes = {"/usr/bin"}, -- check = function (tool) os.run("%s -h", tool) end, version = true -- force = true, cachekey = "xxx"} -- diff --git a/xmake/modules/lib/detect/find_toolname.lua b/xmake/modules/lib/detect/find_toolname.lua index 02a1df105..474732705 100644 --- a/xmake/modules/lib/detect/find_toolname.lua +++ b/xmake/modules/lib/detect/find_toolname.lua @@ -68,7 +68,7 @@ end -- find tool name -- --- .e.g +-- e.g. -- "xcrun -sdk macosx clang": clang -- "/usr/bin/arm-linux-gcc": gcc -- "link.exe -lib": link diff --git a/xmake/modules/lib/detect/has_cfuncs.lua b/xmake/modules/lib/detect/has_cfuncs.lua index af1447852..86b67dce9 100644 --- a/xmake/modules/lib/detect/has_cfuncs.lua +++ b/xmake/modules/lib/detect/has_cfuncs.lua @@ -25,7 +25,7 @@ import("lib.detect.check_csnippets") -- -- @param funcs the funcs -- @param opt the argument options --- .e.g +-- e.g. -- { verbose = false, target = [target|option], includes = "", configs = {linkdirs = .., links = .., defines = .., ..}} -- -- funcs: diff --git a/xmake/modules/lib/detect/has_cincludes.lua b/xmake/modules/lib/detect/has_cincludes.lua index 35817069a..7f4f67816 100644 --- a/xmake/modules/lib/detect/has_cincludes.lua +++ b/xmake/modules/lib/detect/has_cincludes.lua @@ -25,7 +25,7 @@ import("lib.detect.check_cxsnippets") -- -- @param includes the includes -- @param opt the argument options --- .e.g +-- e.g. -- { verbose = false, target = [target|option], configs = {defines = "..", .. }} -- -- @return true or false diff --git a/xmake/modules/lib/detect/has_ctypes.lua b/xmake/modules/lib/detect/has_ctypes.lua index 982c06477..9f1e5a57e 100644 --- a/xmake/modules/lib/detect/has_ctypes.lua +++ b/xmake/modules/lib/detect/has_ctypes.lua @@ -25,7 +25,7 @@ import("lib.detect.check_cxsnippets") -- -- @param types the types -- @param opt the argument options --- .e.g +-- e.g. -- { verbose = false, target = [target|option], includes = .., configs = {defines = .., ..}} -- -- @return true or false diff --git a/xmake/modules/lib/detect/has_cxxfuncs.lua b/xmake/modules/lib/detect/has_cxxfuncs.lua index 6a545267a..e125d6151 100644 --- a/xmake/modules/lib/detect/has_cxxfuncs.lua +++ b/xmake/modules/lib/detect/has_cxxfuncs.lua @@ -25,7 +25,7 @@ import("lib.detect.check_cxxsnippets") -- -- @param funcs the funcs -- @param opt the argument options --- .e.g +-- e.g. -- { verbose = false, target = [target|option], includes = "", configs = {linkdirs = .., links = .., defines = .., ..}} -- -- funcs: diff --git a/xmake/modules/lib/detect/has_cxxincludes.lua b/xmake/modules/lib/detect/has_cxxincludes.lua index 01f52879c..9941331dc 100644 --- a/xmake/modules/lib/detect/has_cxxincludes.lua +++ b/xmake/modules/lib/detect/has_cxxincludes.lua @@ -25,7 +25,7 @@ import("lib.detect.check_cxsnippets") -- -- @param includes the includes -- @param opt the argument options --- .e.g +-- e.g. -- { verbose = false, target = [target|option], configs = {defines = "..", .. }} -- -- @return true or false diff --git a/xmake/modules/lib/detect/has_cxxtypes.lua b/xmake/modules/lib/detect/has_cxxtypes.lua index de350f2e8..9db374260 100644 --- a/xmake/modules/lib/detect/has_cxxtypes.lua +++ b/xmake/modules/lib/detect/has_cxxtypes.lua @@ -25,7 +25,7 @@ import("lib.detect.check_cxsnippets") -- -- @param types the types -- @param opt the argument options --- .e.g +-- e.g. -- { verbose = false, target = [target|option], includes = .., configs = {defines = .., ..}} -- -- @return true or false diff --git a/xmake/modules/lib/detect/has_features.lua b/xmake/modules/lib/detect/has_features.lua index 1bcd7cc9a..d8fc8e051 100644 --- a/xmake/modules/lib/detect/has_features.lua +++ b/xmake/modules/lib/detect/has_features.lua @@ -26,7 +26,7 @@ import("lib.detect.features", {alias = "get_features"}) -- -- @param name the tool name -- @param features the features --- @param opt the argument options, .e.g {verbose = false, flags = {}, program = ""}} +-- @param opt the argument options, e.g. {verbose = false, flags = {}, program = ""}} -- -- @return the supported features or nil -- diff --git a/xmake/modules/lib/detect/has_flags.lua b/xmake/modules/lib/detect/has_flags.lua index bebe836d2..bce47582b 100644 --- a/xmake/modules/lib/detect/has_flags.lua +++ b/xmake/modules/lib/detect/has_flags.lua @@ -28,7 +28,7 @@ import("lib.detect.find_tool") -- -- @param name the tool name -- @param flags the flags --- @param opt the argument options, .e.g { verbose = false, program = "", sysflags = {}, flagkind = "cxflag", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]", flagskey = "custom key" } +-- @param opt the argument options, e.g. { verbose = false, program = "", sysflags = {}, flagkind = "cxflag", toolkind = "[cc|cxx|ld|ar|sh|gc|rc|dc|mm|mxx]", flagskey = "custom key" } -- -- @return true or false -- @@ -64,7 +64,7 @@ function main(name, flags, opt) -- get tool architecture -- - -- some tools select arch by path environment, not be flags, .e.g cl.exe of msvc) + -- some tools select arch by path environment, not be flags, e.g. cl.exe of msvc) -- so, it will affect the cache result -- local arch = config.get("arch") or os.arch() @@ -72,7 +72,7 @@ function main(name, flags, opt) -- init cache key local key = plat .. "_" .. arch .. "_" .. tool.program .. "_" .. (tool.version or "") .. "_" .. (opt.toolkind or "") .. "_" .. (opt.flagkind or "") .. "_" .. table.concat(opt.sysflags, " ") .. "_" .. opt.flagskey - -- @note avoid detect the same program in the same time if running in the coroutine (.e.g ccache) + -- @note avoid detect the same program in the same time if running in the coroutine (e.g. ccache) local coroutine_running = coroutine.running() if coroutine_running then while _g._checking ~= nil and _g._checking == key do @@ -92,7 +92,7 @@ function main(name, flags, opt) -- generate all checked flags local checkflags = table.join(flags, opt.sysflags) - -- split flag group, .e.g "-I /xxx" => {"-I", "/xxx"} + -- split flag group, e.g. "-I /xxx" => {"-I", "/xxx"} local results = {} for _, flag in ipairs(checkflags) do flag = flag:trim() diff --git a/xmake/modules/package/manager/apt/install_package.lua b/xmake/modules/package/manager/apt/install_package.lua index 9f46cdb98..c74f1e897 100644 --- a/xmake/modules/package/manager/apt/install_package.lua +++ b/xmake/modules/package/manager/apt/install_package.lua @@ -26,7 +26,7 @@ import("privilege.sudo") -- install package -- -- @param name the package name --- @param opt the options, .e.g {verbose = true, apt = "the package name"} +-- @param opt the options, e.g. {verbose = true, apt = "the package name"} -- -- @return true or false -- diff --git a/xmake/modules/package/manager/brew/find_package.lua b/xmake/modules/package/manager/brew/find_package.lua index b666144ca..5eb2beba3 100644 --- a/xmake/modules/package/manager/brew/find_package.lua +++ b/xmake/modules/package/manager/brew/find_package.lua @@ -26,7 +26,7 @@ import("package.manager.find_package") -- find package from the brew package manager -- -- @param name the package name, e.g. zlib, pcre/libpcre16 --- @param opt the options, .e.g {verbose = true, version = "1.12.x") +-- @param opt the options, e.g. {verbose = true, version = "1.12.x") -- function main(name, opt) @@ -36,7 +36,7 @@ function main(name, opt) return end - -- parse name, .e.g pcre/libpcre16 + -- parse name, e.g. pcre/libpcre16 local nameinfo = name:split('/') local pcname = nameinfo[2] or nameinfo[1] diff --git a/xmake/modules/package/manager/brew/install_package.lua b/xmake/modules/package/manager/brew/install_package.lua index 07059d02e..1e341ab01 100644 --- a/xmake/modules/package/manager/brew/install_package.lua +++ b/xmake/modules/package/manager/brew/install_package.lua @@ -25,7 +25,7 @@ import("lib.detect.find_tool") -- install package -- -- @param name the package name, e.g. pcre2, pcre2/libpcre2-8 --- @param opt the options, .e.g {verbose = true} +-- @param opt the options, e.g. {verbose = true} -- -- @return true or false -- diff --git a/xmake/modules/package/manager/clib/install_package.lua b/xmake/modules/package/manager/clib/install_package.lua index 0fb057183..0ea088689 100644 --- a/xmake/modules/package/manager/clib/install_package.lua +++ b/xmake/modules/package/manager/clib/install_package.lua @@ -35,7 +35,7 @@ end -- install package -- @param name the package name, e.g. clib::clibs/[email protected] --- @param opt the options, .e.g { verbose = true, +-- @param opt the options, e.g. { verbose = true, -- settings = {outputdir = "clib", save = false, save_dev = false}} -- -- @return true or false diff --git a/xmake/modules/package/manager/conan/find_package.lua b/xmake/modules/package/manager/conan/find_package.lua index 7f20fd3b9..52c136d3e 100644 --- a/xmake/modules/package/manager/conan/find_package.lua +++ b/xmake/modules/package/manager/conan/find_package.lua @@ -50,7 +50,7 @@ end -- find package using the conan package manager -- -- @param name the package name --- @param opt the options, .e.g {verbose = true, version = "1.12.x") +-- @param opt the options, e.g. {verbose = true, version = "1.12.x") -- function main(name, opt) diff --git a/xmake/modules/package/manager/conan/install_package.lua b/xmake/modules/package/manager/conan/install_package.lua index c2496f46d..5585e2da1 100644 --- a/xmake/modules/package/manager/conan/install_package.lua +++ b/xmake/modules/package/manager/conan/install_package.lua @@ -98,7 +98,7 @@ end -- install package -- -- @param name the package name, e.g. conan::OpenSSL/1.0.2n@conan/stable --- @param opt the options, .e.g { verbose = true, mode = "release", plat = , arch = , +-- @param opt the options, e.g. { verbose = true, mode = "release", plat = , arch = , -- remote = "", build = "all", options = {}, imports = {}, build_requires = {}, -- settings = {"compiler=Visual Studio", "compiler.version=10", "compiler.runtime=MD"}} -- diff --git a/xmake/modules/package/manager/install_package.lua b/xmake/modules/package/manager/install_package.lua index 1a5451758..8dc173a81 100644 --- a/xmake/modules/package/manager/install_package.lua +++ b/xmake/modules/package/manager/install_package.lua @@ -81,7 +81,7 @@ end -- install package using the package manager -- -- @param name the package name, e.g. zlib 1.12.x (try all), XMAKE::zlib 1.12.x, BREW::zlib, VCPKG::zlib, CONAN::OpenSSL/1.0.2n@conan/stable --- @param opt the options, .e.g {verbose = true, version = "1.12.x") +-- @param opt the options, e.g. {verbose = true, version = "1.12.x") -- function main(name, opt) diff --git a/xmake/modules/package/manager/pacman/install_package.lua b/xmake/modules/package/manager/pacman/install_package.lua index f06b698f3..0103e9121 100644 --- a/xmake/modules/package/manager/pacman/install_package.lua +++ b/xmake/modules/package/manager/pacman/install_package.lua @@ -26,7 +26,7 @@ import("privilege.sudo") -- install package -- -- @param name the package name --- @param opt the options, .e.g {verbose = true, pacman = "the package name"} +-- @param opt the options, e.g. {verbose = true, pacman = "the package name"} -- -- @return true or false -- diff --git a/xmake/modules/package/manager/pkg_config/find_package.lua b/xmake/modules/package/manager/pkg_config/find_package.lua index 552b3a8a2..07054217a 100644 --- a/xmake/modules/package/manager/pkg_config/find_package.lua +++ b/xmake/modules/package/manager/pkg_config/find_package.lua @@ -24,7 +24,7 @@ import("lib.detect.pkg_config") -- find package from the pkg-config package manager -- -- @param name the package name --- @param opt the options, .e.g {verbose = true, version = "1.12.x") +-- @param opt the options, e.g. {verbose = true, version = "1.12.x") -- function main(name, opt) return pkg_config.find(name, opt) diff --git a/xmake/modules/package/manager/system/find_package.lua b/xmake/modules/package/manager/system/find_package.lua index c698a558e..5d07e1e8c 100644 --- a/xmake/modules/package/manager/system/find_package.lua +++ b/xmake/modules/package/manager/system/find_package.lua @@ -26,7 +26,7 @@ import("lib.detect.pkg_config") -- find package from the system directories -- -- @param name the package name --- @param opt the options, .e.g {verbose = true, version = "1.12.x") +-- @param opt the options, e.g. {verbose = true, version = "1.12.x") -- function main(name, opt) @@ -75,7 +75,7 @@ function main(name, opt) end end - -- uses name as links directly .e.g libname.a + -- uses name as links directly e.g. libname.a if #links == 0 then links = table.wrap(name) end diff --git a/xmake/modules/package/manager/vcpkg/find_package.lua b/xmake/modules/package/manager/vcpkg/find_package.lua index 3d01a0d55..774d455b6 100644 --- a/xmake/modules/package/manager/vcpkg/find_package.lua +++ b/xmake/modules/package/manager/vcpkg/find_package.lua @@ -28,7 +28,7 @@ import("core.project.target") -- find package from the brew package manager -- -- @param name the package name, e.g. zlib, pcre/libpcre16 --- @param opt the options, .e.g {verbose = true, version = "1.12.x") +-- @param opt the options, e.g. {verbose = true, version = "1.12.x") -- function main(name, opt) @@ -55,7 +55,7 @@ function main(name, opt) -- get the vcpkg info directory local infodir = path.join(installdir, "vcpkg", "info") - -- find the package info file, .e.g zlib_1.2.11-3_x86-windows.list + -- find the package info file, e.g. zlib_1.2.11-3_x86-windows.list local infofile = find_file(format("%s_*_%s-%s.list", name, arch, plat), infodir) -- save includedirs, linkdirs and links diff --git a/xmake/modules/package/manager/vcpkg/install_package.lua b/xmake/modules/package/manager/vcpkg/install_package.lua index 2ef3bae90..3ee244c2f 100644 --- a/xmake/modules/package/manager/vcpkg/install_package.lua +++ b/xmake/modules/package/manager/vcpkg/install_package.lua @@ -25,7 +25,7 @@ import("detect.sdks.find_vcpkgdir") -- install package -- -- @param name the package name, e.g. pcre2, pcre2/libpcre2-8 --- @param opt the options, .e.g {verbose = true} +-- @param opt the options, e.g. {verbose = true} -- -- @return true or false -- diff --git a/xmake/modules/package/manager/xmake/find_package.lua b/xmake/modules/package/manager/xmake/find_package.lua index 595612ba2..d78fa60fd 100644 --- a/xmake/modules/package/manager/xmake/find_package.lua +++ b/xmake/modules/package/manager/xmake/find_package.lua @@ -36,7 +36,7 @@ function _find_package_from_repo(name, opt) return end - -- find the manifest file of package, .e.g ~/.xmake/packages/z/zlib/1.1.12/ed41d5327fad3fc06fe376b4a94f62ef/manifest.txt + -- find the manifest file of package, e.g. ~/.xmake/packages/z/zlib/1.1.12/ed41d5327fad3fc06fe376b4a94f62ef/manifest.txt local packagedirs = {} table.insert(packagedirs, path.join(package.installdir(), name:sub(1, 1), name, opt.version, opt.buildhash)) local manifest_file = find_file("manifest.txt", packagedirs) @@ -108,7 +108,7 @@ function _find_package_from_repo(name, opt) table.insert(linkdirs, path.join(installdir, "lib")) end - -- uses name as links directly .e.g libname.a + -- uses name as links directly e.g. libname.a if #links == 0 then links = table.wrap(name) end @@ -152,7 +152,7 @@ end -- find package from the package directories function _find_package_from_packagedirs(name, opt) - -- get package path (.e.g name.pkg) in the package directories + -- get package path (e.g. name.pkg) in the package directories local packagepath = nil for _, dir in ipairs(table.wrap(opt.packagedirs)) do local p = path.join(dir, name .. ".pkg") @@ -165,7 +165,7 @@ function _find_package_from_packagedirs(name, opt) return end - -- get package file (.e.g name.pkg/xmake.lua) + -- get package file (e.g. name.pkg/xmake.lua) local packagefile = path.join(packagepath, "xmake.lua") if not os.isfile(packagefile) then return @@ -248,7 +248,7 @@ end -- find package using the xmake package manager -- -- @param name the package name --- @param opt the options, .e.g {verbose = true, version = "1.12.x", buildhash = "xxxxxx") +-- @param opt the options, e.g. {verbose = true, version = "1.12.x", buildhash = "xxxxxx") -- function main(name, opt) diff --git a/xmake/modules/package/manager/yum/install_package.lua b/xmake/modules/package/manager/yum/install_package.lua index 616204eb7..04b1fe735 100644 --- a/xmake/modules/package/manager/yum/install_package.lua +++ b/xmake/modules/package/manager/yum/install_package.lua @@ -26,7 +26,7 @@ import("privilege.sudo") -- install package -- -- @param name the package name --- @param opt the options, .e.g {verbose = true, yum = "the package name"} +-- @param opt the options, e.g. {verbose = true, yum = "the package name"} -- -- @return true or false -- diff --git a/xmake/modules/private/detect/find_cudatool.lua b/xmake/modules/private/detect/find_cudatool.lua index 0583e3a6b..cf4039064 100644 --- a/xmake/modules/private/detect/find_cudatool.lua +++ b/xmake/modules/private/detect/find_cudatool.lua @@ -26,9 +26,9 @@ import("detect.sdks.find_cuda") -- find cuda tool -- --- @param toolname name of cuda tool, .e.g "nvcc" +-- @param toolname name of cuda tool, e.g. "nvcc" -- parse default pattern for version string --- opt the argument options, .e.g {version = true} +-- opt the argument options, e.g. {version = true} -- -- @return program, version -- diff --git a/xmake/modules/privilege/sudo.lua b/xmake/modules/privilege/sudo.lua index dd529de91..464a9252f 100644 --- a/xmake/modules/privilege/sudo.lua +++ b/xmake/modules/privilege/sudo.lua @@ -38,7 +38,7 @@ end -- sudo run command with administrator permission -- --- .e.g +-- e.g. -- _sudo(os.run, "echo", "hello xmake!") -- function _sudo(runner, cmd, ...) @@ -53,7 +53,7 @@ end -- sudo run command with administrator permission and arguments list -- --- .e.g +-- e.g. -- _sudov(os.runv, {"echo", "hello xmake!"}) -- function _sudov(runner, program, argv, opt) @@ -68,7 +68,7 @@ end -- sudo run lua script with administrator permission and arguments list -- --- .e.g +-- e.g. -- _lua(os.runv, "xxx.lua", {"arg1", "arg2"}) -- function _lua(runner, luafile, luaargv) diff --git a/xmake/modules/utils/archive/extract.lua b/xmake/modules/utils/archive/extract.lua index 87814c6d2..305e9f325 100644 --- a/xmake/modules/utils/archive/extract.lua +++ b/xmake/modules/utils/archive/extract.lua @@ -347,7 +347,7 @@ end -- -- @param archivefile the archive file. e.g. *.tar.gz, *.zip, *.7z, *.tar.bz2, .. -- @param outputdir the output directory --- @param options the options, .e.g. {excludes = {"*/dir/*", "dir/*"}} +-- @param options the options, e.g.. {excludes = {"*/dir/*", "dir/*"}} -- function main(archivefile, outputdir, opt) diff --git a/xmake/platforms/windows/xmake.lua b/xmake/platforms/windows/xmake.lua index 088f68a46..90511bf57 100644 --- a/xmake/platforms/windows/xmake.lua +++ b/xmake/platforms/windows/xmake.lua @@ -54,11 +54,11 @@ platform("windows") { {category = "Visual Studio SDK Configuration" } , {nil, "vs", "kv", "auto", "The Microsoft Visual Studio" - , " .e.g --vs=2017" } + , " e.g. --vs=2017" } , {nil, "vs_toolset", "kv", nil, "The Microsoft Visual Studio Toolset Version" - , " .e.g --vs_toolset=14.0" } + , " e.g. --vs_toolset=14.0" } , {nil, "vs_sdkver", "kv", nil, "The Windows SDK Version of Visual Studio" - , " .e.g --vs_sdkver=10.0.15063.0" } + , " e.g. --vs_sdkver=10.0.15063.0" } , {category = "Cuda SDK Configuration" } , {nil, "cuda", "kv", "auto", "The Cuda SDK Directory" } , {category = "Qt SDK Configuration" } diff --git a/xmake/plugins/lua/scripts/lipo.lua b/xmake/plugins/lua/scripts/lipo.lua index 581876f3c..62dbf5683 100644 --- a/xmake/plugins/lua/scripts/lipo.lua +++ b/xmake/plugins/lua/scripts/lipo.lua @@ -23,7 +23,7 @@ import("detect.tools.find_lipo") -- main -- --- .e.g. +-- e.g.. -- -- xmake l lipo "-create -arch armv7 file -arch arm64 file -output file" function main(...) diff --git a/xmake/plugins/lua/xmake.lua b/xmake/plugins/lua/xmake.lua index b6d66a670..dc5e56e67 100644 --- a/xmake/plugins/lua/xmake.lua +++ b/xmake/plugins/lua/xmake.lua @@ -111,7 +111,7 @@ task("lua") {'l', "list", "k", nil, "List all scripts." } , {'c', "command", "k", nil, "Run script as command" } , {nil, "script", "v", nil, "Run the given lua script name, file or module and enter interactive mode if no given script.", - ".e.g", + "e.g.", " - xmake lua (enter interactive mode)", " - xmake lua /tmp/script.lua", " - xmake lua echo 'hello xmake'", diff --git a/xmake/plugins/macro/macros/package.lua b/xmake/plugins/macro/macros/package.lua index d46b42820..a6b2f2a0b 100644 --- a/xmake/plugins/macro/macros/package.lua +++ b/xmake/plugins/macro/macros/package.lua @@ -28,14 +28,14 @@ import("core.platform.platform") local options = { {'p', "plat", "kv", os.host(), "Set the platform." } -, {'a', "arch", "kv", nil, "Set the architectures. .e.g 'armv7, arm64'" } +, {'a', "arch", "kv", nil, "Set the architectures. e.g. 'armv7, arm64'" } , {'f', "config", "kv", nil, "Pass the config arguments to \"xmake config\" .." } , {'o', "outputdir", "kv", nil, "Set the output directory of the package." } } -- package all -- --- .e.g +-- e.g. -- xmake m package -- xmake m package -f "-m debug" -- xmake m package -p linux diff --git a/xmake/plugins/macro/xmake.lua b/xmake/plugins/macro/xmake.lua index 7c6a9e1a3..40a9ef3b7 100644 --- a/xmake/plugins/macro/xmake.lua +++ b/xmake/plugins/macro/xmake.lua @@ -42,7 +42,7 @@ task("macro") , options = { {'b', "begin", "k", nil, "Start to record macro." - , ".e.g" + , "e.g." , "Record macro with name: test" , " xmake macro --begin" , " xmake config --plat=macosx" @@ -58,16 +58,16 @@ task("macro") , {'c', "clear", "k", nil, "Clear the all macros." } , {} , {nil, "import", "kv", nil, "Import the given macro file or directory." - , ".e.g" + , "e.g." , " xmake macro --import=/xxx/macro.lua test" , " xmake macro --import=/xxx/macrodir" } , {nil, "export", "kv", nil, "Export the given macro to file or directory." - , ".e.g" + , "e.g." , " xmake macro --export=/xxx/macro.lua test" , " xmake macro --export=/xxx/macrodir" } , {} , {nil, "name", "v", ".", "Set the macro name." - , ".e.g" + , "e.g." , " Run the given macro: xmake macro test" , " Run the anonymous macro: xmake macro ." , " Run the last command: xmake macro .." } diff --git a/xmake/plugins/project/vstudio/impl/vs200x_vcproj.lua b/xmake/plugins/project/vstudio/impl/vs200x_vcproj.lua index 91769a6bf..d2066a659 100644 --- a/xmake/plugins/project/vstudio/impl/vs200x_vcproj.lua +++ b/xmake/plugins/project/vstudio/impl/vs200x_vcproj.lua @@ -152,7 +152,7 @@ end -- make VCCLCompilerTool -- --- .e.g +-- e.g. -- -- <Tool -- Name="VCCLCompilerTool" @@ -188,7 +188,7 @@ end -- make VCLinkerTool -- --- .e.g +-- e.g. -- <Tool -- Name="VCLinkerTool" -- AdditionalDependencies="xxx.lib" @@ -393,7 +393,7 @@ end -- make cxfile -- --- .e.g +-- e.g. -- <File -- RelativePath="..\..\..\src\file3.c" -- > @@ -449,7 +449,7 @@ end -- make rcfile -- --- .e.g +-- e.g. -- <File -- RelativePath="..\..\..\src\resource.rc" -- > @@ -490,7 +490,7 @@ end -- make files -- --- .e.g +-- e.g. -- <Filter -- Name="Source Files" -- > diff --git a/xmake/plugins/project/xmake.lua b/xmake/plugins/project/xmake.lua index 88d8a1ced..3b76d6df7 100644 --- a/xmake/plugins/project/xmake.lua +++ b/xmake/plugins/project/xmake.lua @@ -46,10 +46,10 @@ task("project") , " - vs2010, vs2012, vs2013, vs2015, vs2017, vs2019" , " - vsxmake2010 ~ vsmake2019" } , {'m', "modes", "kv", nil, "Set the project modes." - , " .e.g " + , " e.g. " , " - xmake project -k vs2015 -m \"release" .. path.envsep() .. "debug\"" } , {'a', "archs", "kv", nil, "Set the project archs." - , " .e.g " + , " e.g. " , " - xmake project -k vs2015 -a \"x86" .. path.envsep() .. "x64\"" } , {nil, "outputdir", "v", ".", "Set the output directory." } } |