Skip to content

Fix yard doc #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 14, 2024
Merged

Fix yard doc #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/ruby_header_parser/config.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ module RubyHeaderParser
# Manager for config file
class Config
# @!attribute [r] data
# @return [Hash]
# @return [Hash]
attr_reader :data

# @param config_file [String]
Expand Down
2 changes: 1 addition & 1 deletion lib/ruby_header_parser/enum_definition.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ class EnumDefinition
# @return [String]
attr_accessor :name

# @!attribute enum_value_definitions
# @!attribute values
# @return [Array<String>]
attr_accessor :values

Expand Down
10 changes: 5 additions & 5 deletions lib/ruby_header_parser/parser.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ module RubyHeaderParser
# parse `ruby.h` using `ctags`
class Parser # rubocop:disable Metrics/ClassLength
# @!attribute [r] header_file
# @return [String]
# @return [String]
attr_reader :header_file

# @!attribute [r] include_paths
# @return [Array<String>]
# @return [Array<String>]
attr_reader :include_paths

# @!attribute [r] dist_preprocessed_header_file
# @return [String]
# @return [String]
attr_reader :dist_preprocessed_header_file

# @!attribute [r] data
# @return [RubyHeaderParser::Config]
# @!attribute [r] config
# @return [RubyHeaderParser::Config]
attr_reader :config

DEFAULT_HEADER_FILE = "#{RbConfig::CONFIG["rubyhdrdir"]}/ruby.h".freeze
Expand Down