Skip to content

Commit

Permalink
update doc comments on Env type
Browse files Browse the repository at this point in the history
  • Loading branch information
Techatrix committed Dec 22, 2024
1 parent b8dfb2c commit 25ac14e
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/main.zig
Original file line number Diff line number Diff line change
Expand Up @@ -140,17 +140,17 @@ const Env = struct {
///
version: []const u8,
global_cache_dir: ?[]const u8,
/// Path to where a global `zls.json` could be located.
/// Not `null` unless `known-folders` was unable to find a global configuration directory.
/// Path to a global configuration directory relative to which ZLS configuration files will be searched.
/// Not `null` unless [known-folders](https://github.com/ziglibs/known-folders) was unable to find a global configuration directory.
global_config_dir: ?[]const u8,
/// Path to where a local `zls.json` could be located.
/// Not `null` unless `known-folders` was unable to find a local configuration directory.
/// Path to a user specific configuration directory relative to which configuration files will be searched.
/// Not `null` unless [known-folders](https://github.com/ziglibs/known-folders) was unable to find a local configuration directory.
local_config_dir: ?[]const u8,
/// Path to a `zls.json` config file. Will be resolved by looking in the local configuration directory and then falling back to global directory.
/// Path to a `zls.json` config file. Will be resolved by looking in the local configuration directory and then falling back to the global directory.
/// Can be null if no `zls.json` was found in the global/local config directory.
config_file: ?[]const u8,
/// Path to a `zls.log` where ZLS will attempt to append logging output.
/// Not `null` unless `known-folders` was unable to find a cache directory.
/// Path to a `zls.log` file where ZLS will append logging output. The file may be truncated or cleared by ZLS.
/// Not `null` unless [known-folders](https://github.com/ziglibs/known-folders) was unable to find a cache directory.
log_file: ?[]const u8,
};

Expand Down

0 comments on commit 25ac14e

Please sign in to comment.