Doc: improves overall English grammer

This commit is contained in:
李通洲
2026-04-16 18:27:11 +08:00
parent 528f9f152c
commit c601b68bc6
45 changed files with 384 additions and 384 deletions
+2 -2
View File
@@ -314,7 +314,7 @@ void ffDestroyBatteryOptions(FFBatteryOptions* options) {
FFModuleBaseInfo ffBatteryModuleInfo = {
.name = FF_BATTERY_MODULE_NAME,
.description = "Print battery capacity, status, etc",
.description = "Print battery information",
.initOptions = (void*) ffInitBatteryOptions,
.destroyOptions = (void*) ffDestroyBatteryOptions,
.parseJsonObject = (void*) ffParseBatteryJsonObject,
@@ -330,7 +330,7 @@ FFModuleBaseInfo ffBatteryModuleInfo = {
{ "Battery temperature (formatted)", "temperature" },
{ "Battery cycle count", "cycle-count" },
{ "Battery serial number", "serial" },
{ "Battery manufactor date", "manufacture-date" },
{ "Battery manufacture date", "manufacture-date" },
{ "Battery capacity (percentage bar)", "capacity-bar" },
{ "Battery time remaining days", "time-days" },
{ "Battery time remaining hours", "time-hours" },
+5 -5
View File
@@ -131,7 +131,7 @@ void ffDestroyBiosOptions(FFBiosOptions* options) {
FFModuleBaseInfo ffBiosModuleInfo = {
.name = FF_BIOS_MODULE_NAME,
.description = "Print information of 1st-stage bootloader (name, version, release date, etc)",
.description = "Print first-stage bootloader information (name, version, release date, etc.)",
.initOptions = (void*) ffInitBiosOptions,
.destroyOptions = (void*) ffDestroyBiosOptions,
.parseJsonObject = (void*) ffParseBiosJsonObject,
@@ -139,10 +139,10 @@ FFModuleBaseInfo ffBiosModuleInfo = {
.generateJsonResult = (void*) ffGenerateBiosJsonResult,
.generateJsonConfig = (void*) ffGenerateBiosJsonConfig,
.formatArgs = FF_FORMAT_ARG_LIST(((FFModuleFormatArg[]) {
{ "Bios date", "date" },
{ "Bios release", "release" },
{ "Bios vendor", "vendor" },
{ "Bios version", "version" },
{ "BIOS date", "date" },
{ "BIOS release", "release" },
{ "BIOS vendor", "vendor" },
{ "BIOS version", "version" },
{ "Firmware type", "type" },
}))
};
+1 -1
View File
@@ -151,7 +151,7 @@ void ffDestroyBluetoothOptions(FFBluetoothOptions* options) {
FFModuleBaseInfo ffBluetoothModuleInfo = {
.name = FF_BLUETOOTH_MODULE_NAME,
.description = "List (connected) bluetooth devices",
.description = "List connected Bluetooth devices",
.initOptions = (void*) ffInitBluetoothOptions,
.destroyOptions = (void*) ffDestroyBluetoothOptions,
.parseJsonObject = (void*) ffParseBluetoothJsonObject,
+1 -1
View File
@@ -189,7 +189,7 @@ void ffDestroyBluetoothRadioOptions(FFBluetoothRadioOptions* options) {
FFModuleBaseInfo ffBluetoothRadioModuleInfo = {
.name = FF_BLUETOOTHRADIO_MODULE_NAME,
.description = "List bluetooth radios width supported version and vendor",
.description = "List Bluetooth radios (supported versions, vendors, etc.)",
.initOptions = (void*) ffInitBluetoothRadioOptions,
.destroyOptions = (void*) ffDestroyBluetoothRadioOptions,
.parseJsonObject = (void*) ffParseBluetoothRadioJsonObject,
+1 -1
View File
@@ -109,7 +109,7 @@ void ffDestroyBoardOptions(FFBoardOptions* options) {
FFModuleBaseInfo ffBoardModuleInfo = {
.name = FF_BOARD_MODULE_NAME,
.description = "Print motherboard name and other info",
.description = "Print motherboard name and other information",
.initOptions = (void*) ffInitBoardOptions,
.destroyOptions = (void*) ffDestroyBoardOptions,
.parseJsonObject = (void*) ffParseBoardJsonObject,
+1 -1
View File
@@ -104,7 +104,7 @@ void ffDestroyBootmgrOptions(FFBootmgrOptions* options) {
FFModuleBaseInfo ffBootmgrModuleInfo = {
.name = FF_BOOTMGR_MODULE_NAME,
.description = "Print information of 2nd-stage bootloader (name, firmware, etc)",
.description = "Print second-stage bootloader information (name, firmware, etc.)",
.initOptions = (void*) ffInitBootmgrOptions,
.destroyOptions = (void*) ffDestroyBootmgrOptions,
.parseJsonObject = (void*) ffParseBootmgrJsonObject,
+1 -1
View File
@@ -28,7 +28,7 @@ void ffDestroyBreakOptions(FF_A_UNUSED FFBreakOptions* options) {
FFModuleBaseInfo ffBreakModuleInfo = {
.name = FF_BREAK_MODULE_NAME,
.description = "Print a empty line",
.description = "Print an empty line",
.initOptions = (void*) ffInitBreakOptions,
.destroyOptions = (void*) ffDestroyBreakOptions,
.parseJsonObject = (void*) ffParseBreakJsonObject,
+1 -1
View File
@@ -183,7 +183,7 @@ void ffDestroyBrightnessOptions(FFBrightnessOptions* options) {
FFModuleBaseInfo ffBrightnessModuleInfo = {
.name = FF_BRIGHTNESS_MODULE_NAME,
.description = "Print current brightness level of your monitors",
.description = "Print the current brightness level of your monitors",
.initOptions = (void*) ffInitBrightnessOptions,
.destroyOptions = (void*) ffDestroyBrightnessOptions,
.parseJsonObject = (void*) ffParseBrightnessJsonObject,
+1 -1
View File
@@ -111,7 +111,7 @@ void ffDestroyChassisOptions(FFChassisOptions* options) {
FFModuleBaseInfo ffChassisModuleInfo = {
.name = FF_CHASSIS_MODULE_NAME,
.description = "Print chassis type (desktop, laptop, etc)",
.description = "Print chassis type information (desktop, laptop, etc.)",
.initOptions = (void*) ffInitChassisOptions,
.destroyOptions = (void*) ffDestroyChassisOptions,
.parseJsonObject = (void*) ffParseChassisJsonObject,
+1 -1
View File
@@ -236,7 +236,7 @@ void ffDestroyCPUOptions(FFCPUOptions* options) {
FFModuleBaseInfo ffCPUModuleInfo = {
.name = FF_CPU_MODULE_NAME,
.description = "Print CPU name, frequency, etc",
.description = "Print CPU name, frequency, etc.",
.initOptions = (void*) ffInitCPUOptions,
.destroyOptions = (void*) ffDestroyCPUOptions,
.parseJsonObject = (void*) ffParseCPUJsonObject,
+1 -1
View File
@@ -182,7 +182,7 @@ void ffDestroyCPUUsageOptions(FFCPUUsageOptions* options) {
FFModuleBaseInfo ffCPUUsageModuleInfo = {
.name = FF_CPUUSAGE_MODULE_NAME,
.description = "Print CPU usage. Costs some time to collect data",
.description = "Print CPU usage. Collecting data takes some time",
.initOptions = (void*) ffInitCPUUsageOptions,
.destroyOptions = (void*) ffDestroyCPUUsageOptions,
.parseJsonObject = (void*) ffParseCPUUsageJsonObject,
+1 -1
View File
@@ -145,7 +145,7 @@ void ffDestroyDateTimeOptions(FFDateTimeOptions* options) {
FFModuleBaseInfo ffDateTimeModuleInfo = {
.name = FF_DATETIME_MODULE_NAME,
.description = "Print current date and time",
.description = "Print the current date and time",
.initOptions = (void*) ffInitDateTimeOptions,
.destroyOptions = (void*) ffDestroyDateTimeOptions,
.parseJsonObject = (void*) ffParseDateTimeJsonObject,
+1 -1
View File
@@ -104,7 +104,7 @@ void ffDestroyEditorOptions(FFEditorOptions* options) {
FFModuleBaseInfo ffEditorModuleInfo = {
.name = FF_EDITOR_MODULE_NAME,
.description = "Print information of the default editor ($VISUAL or $EDITOR)",
.description = "Print information about the default editor ($VISUAL or $EDITOR)",
.initOptions = (void*) ffInitEditorOptions,
.destroyOptions = (void*) ffDestroyEditorOptions,
.parseJsonObject = (void*) ffParseEditorJsonObject,
+1 -1
View File
@@ -190,7 +190,7 @@ void ffDestroyGamepadOptions(FFGamepadOptions* options) {
FFModuleBaseInfo ffGamepadModuleInfo = {
.name = FF_GAMEPAD_MODULE_NAME,
.description = "List (connected) gamepads",
.description = "List connected gamepads",
.initOptions = (void*) ffInitGamepadOptions,
.destroyOptions = (void*) ffDestroyGamepadOptions,
.parseJsonObject = (void*) ffParseGamepadJsonObject,
+1 -1
View File
@@ -455,7 +455,7 @@ void ffDestroyGPUOptions(FFGPUOptions* options) {
FFModuleBaseInfo ffGPUModuleInfo = {
.name = FF_GPU_MODULE_NAME,
.description = "Print GPU names, graphic memory size, type, etc",
.description = "Print GPU names, memory sizes, types, etc",
.initOptions = (void*) ffInitGPUOptions,
.destroyOptions = (void*) ffDestroyGPUOptions,
.parseJsonObject = (void*) ffParseGPUJsonObject,
+1 -1
View File
@@ -137,7 +137,7 @@ void ffDestroyHostOptions(FFHostOptions* options) {
FFModuleBaseInfo ffHostModuleInfo = {
.name = FF_HOST_MODULE_NAME,
.description = "Print product name of your computer",
.description = "Print your computer's product name",
.initOptions = (void*) ffInitHostOptions,
.destroyOptions = (void*) ffDestroyHostOptions,
.parseJsonObject = (void*) ffParseHostJsonObject,
+1 -1
View File
@@ -150,7 +150,7 @@ void ffDestroyKeyboardOptions(FFKeyboardOptions* options) {
FFModuleBaseInfo ffKeyboardModuleInfo = {
.name = FF_KEYBOARD_MODULE_NAME,
.description = "List (connected) keyboards",
.description = "List connected keyboards",
.initOptions = (void*) ffInitKeyboardOptions,
.destroyOptions = (void*) ffDestroyKeyboardOptions,
.parseJsonObject = (void*) ffParseKeyboardJsonObject,
+1 -1
View File
@@ -423,7 +423,7 @@ void ffDestroyLocalIpOptions(FFLocalIpOptions* options) {
FFModuleBaseInfo ffLocalIPModuleInfo = {
.name = FF_LOCALIP_MODULE_NAME,
.description = "List local IP addresses (v4 or v6), MAC addresses, etc",
.description = "List local IP addresses (IPv4 or IPv6), MAC addresses, etc",
.initOptions = (void*) ffInitLocalIpOptions,
.destroyOptions = (void*) ffDestroyLocalIpOptions,
.parseJsonObject = (void*) ffParseLocalIpJsonObject,
+1 -1
View File
@@ -182,7 +182,7 @@ void ffDestroyMediaOptions(FFMediaOptions* options) {
FFModuleBaseInfo ffMediaModuleInfo = {
.name = FF_MEDIA_MODULE_NAME,
.description = "Print playing song name",
.description = "Print the name of the currently playing song",
.initOptions = (void*) ffInitMediaOptions,
.destroyOptions = (void*) ffDestroyMediaOptions,
.parseJsonObject = (void*) ffParseMediaJsonObject,
+1 -1
View File
@@ -119,7 +119,7 @@ void ffDestroyMemoryOptions(FFMemoryOptions* options) {
FFModuleBaseInfo ffMemoryModuleInfo = {
.name = FF_MEMORY_MODULE_NAME,
.description = "Print system memory usage info",
.description = "Print system memory usage information",
.initOptions = (void*) ffInitMemoryOptions,
.destroyOptions = (void*) ffDestroyMemoryOptions,
.parseJsonObject = (void*) ffParseMemoryJsonObject,
+1 -1
View File
@@ -153,7 +153,7 @@ void ffDestroyMouseOptions(FFMouseOptions* options) {
FFModuleBaseInfo ffMouseModuleInfo = {
.name = FF_MOUSE_MODULE_NAME,
.description = "List connected mouses",
.description = "List connected mice",
.initOptions = (void*) ffInitMouseOptions,
.destroyOptions = (void*) ffDestroyMouseOptions,
.parseJsonObject = (void*) ffParseMouseJsonObject,
+1 -1
View File
@@ -121,7 +121,7 @@ void ffDestroyOpenCLOptions(FFOpenCLOptions* options) {
FFModuleBaseInfo ffOpenCLModuleInfo = {
.name = FF_OPENCL_MODULE_NAME,
.description = "Print highest OpenCL version supported by the GPU",
.description = "Print the highest OpenCL version supported by the GPU",
.initOptions = (void*) ffInitOpenCLOptions,
.destroyOptions = (void*) ffDestroyOpenCLOptions,
.parseJsonObject = (void*) ffParseOpenCLJsonObject,
+1 -1
View File
@@ -128,7 +128,7 @@ void ffDestroyOpenGLOptions(FFOpenGLOptions* options) {
FFModuleBaseInfo ffOpenGLModuleInfo = {
.name = FF_OPENGL_MODULE_NAME,
.description = "Print highest OpenGL version supported by the GPU",
.description = "Print the highest OpenGL version supported by the GPU",
.initOptions = (void*) ffInitOpenGLOptions,
.destroyOptions = (void*) ffDestroyOpenGLOptions,
.parseJsonObject = (void*) ffParseOpenGLJsonObject,
+1 -1
View File
@@ -173,7 +173,7 @@ void ffDestroyOSOptions(FFOSOptions* options) {
FFModuleBaseInfo ffOSModuleInfo = {
.name = FF_OS_MODULE_NAME,
.description = "Print operating system name and version",
.description = "Print the OS or Linux distribution name and version",
.initOptions = (void*) ffInitOSOptions,
.destroyOptions = (void*) ffDestroyOSOptions,
.parseJsonObject = (void*) ffParseOSJsonObject,
+1 -1
View File
@@ -110,7 +110,7 @@ void ffDestroyPlayerOptions(FFPlayerOptions* options) {
FFModuleBaseInfo ffPlayerModuleInfo = {
.name = FF_PLAYER_MODULE_NAME,
.description = "Print music player name",
.description = "Print the music player name that is currently active",
.initOptions = (void*) ffInitPlayerOptions,
.destroyOptions = (void*) ffDestroyPlayerOptions,
.parseJsonObject = (void*) ffParsePlayerJsonObject,
+1 -1
View File
@@ -111,7 +111,7 @@ void ffDestroyPublicIpOptions(FFPublicIPOptions* options) {
FFModuleBaseInfo ffPublicIPModuleInfo = {
.name = FF_PUBLICIP_MODULE_NAME,
.description = "Print your public IP address, etc",
.description = "Print your public IP address and related information",
.initOptions = (void*) ffInitPublicIpOptions,
.destroyOptions = (void*) ffDestroyPublicIpOptions,
.parseJsonObject = (void*) ffParsePublicIpJsonObject,
+1 -1
View File
@@ -90,7 +90,7 @@ void ffDestroyShellOptions(FFShellOptions* options) {
FFModuleBaseInfo ffShellModuleInfo = {
.name = FF_SHELL_MODULE_NAME,
.description = "Print current shell name and version",
.description = "Print the current shell name and version",
.initOptions = (void*) ffInitShellOptions,
.destroyOptions = (void*) ffDestroyShellOptions,
.parseJsonObject = (void*) ffParseShellJsonObject,
+1 -1
View File
@@ -200,7 +200,7 @@ void ffDestroySoundOptions(FFSoundOptions* options) {
FFModuleBaseInfo ffSoundModuleInfo = {
.name = FF_SOUND_MODULE_NAME,
.description = "Print sound devices, volume, etc",
.description = "Print sound devices, volume levels, etc",
.initOptions = (void*) ffInitSoundOptions,
.destroyOptions = (void*) ffDestroySoundOptions,
.parseJsonObject = (void*) ffParseSoundJsonObject,
+1 -1
View File
@@ -84,7 +84,7 @@ void ffDestroyTerminalOptions(FFTerminalOptions* options) {
FFModuleBaseInfo ffTerminalModuleInfo = {
.name = FF_TERMINAL_MODULE_NAME,
.description = "Print current terminal name and version",
.description = "Print the current terminal name and version",
.initOptions = (void*) ffInitTerminalOptions,
.destroyOptions = (void*) ffDestroyTerminalOptions,
.parseJsonObject = (void*) ffParseTerminalJsonObject,
+1 -1
View File
@@ -106,7 +106,7 @@ void ffDestroyTerminalFontOptions(FFTerminalFontOptions* options) {
FFModuleBaseInfo ffTerminalFontModuleInfo = {
.name = FF_TERMINALFONT_MODULE_NAME,
.description = "Print font name and size used by current terminal",
.description = "Print the font name and size used by the current terminal",
.initOptions = (void*) ffInitTerminalFontOptions,
.destroyOptions = (void*) ffDestroyTerminalFontOptions,
.parseJsonObject = (void*) ffParseTerminalFontJsonObject,
+1 -1
View File
@@ -77,7 +77,7 @@ void ffDestroyTerminalSizeOptions(FFTerminalSizeOptions* options) {
FFModuleBaseInfo ffTerminalSizeModuleInfo = {
.name = FF_TERMINALSIZE_MODULE_NAME,
.description = "Print current terminal size",
.description = "Print the current terminal size",
.initOptions = (void*) ffInitTerminalSizeOptions,
.destroyOptions = (void*) ffDestroyTerminalSizeOptions,
.parseJsonObject = (void*) ffParseTerminalSizeJsonObject,
+1 -1
View File
@@ -94,7 +94,7 @@ void ffDestroyTerminalThemeOptions(FFTerminalThemeOptions* options) {
FFModuleBaseInfo ffTerminalThemeModuleInfo = {
.name = FF_TERMINALTHEME_MODULE_NAME,
.description = "Print current terminal theme (foreground and background colors)",
.description = "Print the current terminal theme (foreground and background colors)",
.initOptions = (void*) ffInitTerminalThemeOptions,
.destroyOptions = (void*) ffDestroyTerminalThemeOptions,
.parseJsonObject = (void*) ffParseTerminalThemeJsonObject,
+1 -1
View File
@@ -88,7 +88,7 @@ void ffDestroyThemeOptions(FFThemeOptions* options) {
FFModuleBaseInfo ffThemeModuleInfo = {
.name = FF_THEME_MODULE_NAME,
.description = "Print current theme of desktop environment",
.description = "Print the current desktop environment theme",
.initOptions = (void*) ffInitThemeOptions,
.destroyOptions = (void*) ffDestroyThemeOptions,
.parseJsonObject = (void*) ffParseThemeJsonObject,
+1 -1
View File
@@ -177,7 +177,7 @@ void ffDestroyTitleOptions(FFTitleOptions* options) {
FFModuleBaseInfo ffTitleModuleInfo = {
.name = FF_TITLE_MODULE_NAME,
.description = "Print title, which contains your user name, hostname",
.description = "Print the title, including your username and hostname",
.initOptions = (void*) ffInitTitleOptions,
.destroyOptions = (void*) ffDestroyTitleOptions,
.parseJsonObject = (void*) ffParseTitleJsonObject,
+1 -1
View File
@@ -84,7 +84,7 @@ void ffDestroyTPMOptions(FFTPMOptions* options) {
FFModuleBaseInfo ffTPMModuleInfo = {
.name = FF_TPM_MODULE_NAME,
.description = "Print info of Trusted Platform Module (TPM) Security Device",
.description = "Print information about the Trusted Platform Module (TPM) security device",
.initOptions = (void*) ffInitTPMOptions,
.destroyOptions = (void*) ffDestroyTPMOptions,
.parseJsonObject = (void*) ffParseTPMJsonObject,
+1 -1
View File
@@ -84,7 +84,7 @@ void ffDestroyUptimeOptions(FFUptimeOptions* options) {
FFModuleBaseInfo ffUptimeModuleInfo = {
.name = FF_UPTIME_MODULE_NAME,
.description = "Print how long system has been running",
.description = "Print how long the system has been running",
.initOptions = (void*) ffInitUptimeOptions,
.destroyOptions = (void*) ffDestroyUptimeOptions,
.parseJsonObject = (void*) ffParseUptimeJsonObject,
+1 -1
View File
@@ -181,7 +181,7 @@ void ffDestroyUsersOptions(FFUsersOptions* options) {
FFModuleBaseInfo ffUsersModuleInfo = {
.name = FF_USERS_MODULE_NAME,
.description = "Print users currently logged in",
.description = "Print users who are currently logged in",
.initOptions = (void*) ffInitUsersOptions,
.destroyOptions = (void*) ffDestroyUsersOptions,
.parseJsonObject = (void*) ffParseUsersJsonObject,
+1 -1
View File
@@ -95,7 +95,7 @@ void ffDestroyVersionOptions(FFVersionOptions* options) {
FFModuleBaseInfo ffVersionModuleInfo = {
.name = FF_VERSION_MODULE_NAME,
.description = "Print Fastfetch version",
.description = "Print the Fastfetch version and build information",
.initOptions = (void*) ffInitVersionOptions,
.destroyOptions = (void*) ffDestroyVersionOptions,
.parseJsonObject = (void*) ffParseVersionJsonObject,
+1 -1
View File
@@ -133,7 +133,7 @@ void ffDestroyVulkanOptions(FFVulkanOptions* options) {
FFModuleBaseInfo ffVulkanModuleInfo = {
.name = FF_VULKAN_MODULE_NAME,
.description = "Print highest Vulkan version supported by the GPU",
.description = "Print the highest Vulkan version supported by the GPU",
.initOptions = (void*) ffInitVulkanOptions,
.destroyOptions = (void*) ffDestroyVulkanOptions,
.parseJsonObject = (void*) ffParseVulkanJsonObject,
+1 -1
View File
@@ -76,7 +76,7 @@ void ffDestroyWallpaperOptions(FFWallpaperOptions* options) {
FFModuleBaseInfo ffWallpaperModuleInfo = {
.name = FF_WALLPAPER_MODULE_NAME,
.description = "Print image file path of current wallpaper",
.description = "Print the file path of the current wallpaper",
.initOptions = (void*) ffInitWallpaperOptions,
.destroyOptions = (void*) ffDestroyWallpaperOptions,
.parseJsonObject = (void*) ffParseWallpaperJsonObject,
+1 -1
View File
@@ -121,7 +121,7 @@ void ffDestroyWMOptions(FFWMOptions* options) {
FFModuleBaseInfo ffWMModuleInfo = {
.name = FF_WM_MODULE_NAME,
.description = "Print window manager name and version",
.description = "Print the window manager name and version",
.initOptions = (void*) ffInitWMOptions,
.destroyOptions = (void*) ffDestroyWMOptions,
.parseJsonObject = (void*) ffParseWMJsonObject,
+1 -1
View File
@@ -62,7 +62,7 @@ void ffDestroyWMThemeOptions(FFWMThemeOptions* options) {
FFModuleBaseInfo ffWMThemeModuleInfo = {
.name = FF_WMTHEME_MODULE_NAME,
.description = "Print current theme of window manager",
.description = "Print the current window manager theme",
.initOptions = (void*) ffInitWMThemeOptions,
.destroyOptions = (void*) ffDestroyWMThemeOptions,
.parseJsonObject = (void*) ffParseWMThemeJsonObject,