Skip to content

Commit 7ea2d54

Browse files
committed
Add link to CONFIG.md
1 parent 3671b8f commit 7ea2d54

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ See below for details.
5050

5151
https://sue445.github.io/ruby_header_parser/RubyHeaderParser/Parser.html
5252

53+
See [CONFIG.md](CONFIG.md) for config file details
54+
5355
## Development
5456

5557
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

lib/ruby_header_parser/config.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ class Config
88
attr_reader :data
99

1010
# @param config_file [String]
11+
#
12+
# @note See [CONFIG.md](../file.CONFIG.html) for config file details
1113
def initialize(config_file)
1214
yaml = File.read(config_file)
1315
@data = YAML.safe_load(yaml, aliases: true, permitted_classes: [Regexp])

lib/ruby_header_parser/parser.rb

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ class Parser # rubocop:disable Metrics/ClassLength
3434
#
3535
# @note `dist_preprocessed_header_file` is used as the output destination for temporary files when the parser
3636
# is executed
37+
#
38+
# @note See [CONFIG.md](../file.CONFIG.html) for config file details
3739
def initialize(dist_preprocessed_header_file: nil, header_file: DEFAULT_HEADER_FILE,
3840
include_paths: DEFAULT_INCLUDE_PATHS, config_file: nil)
3941
@header_file = header_file

0 commit comments

Comments
 (0)