|
1 | | -# Copyright (C) 2012-2019 Sutou Kouhei <[email protected]> |
| 1 | +# Copyright (C) 2012-2023 Sutou Kouhei <[email protected]> |
2 | 2 | # Copyright (C) 2010 masone (Christian Felder) <[email protected]> |
3 | 3 | # Copyright (C) 2009 Masao Mutoh |
4 | 4 | # |
@@ -282,6 +282,9 @@ def escape(string) |
282 | 282 | # Wraps long lines that is longer than the `:max_line_width`. |
283 | 283 | # Don't break long lines if `:max_line_width` is less than 0 |
284 | 284 | # such as `-1`. |
| 285 | + # @option options [Bool] :use_one_line_per_reference (false) |
| 286 | + # Whether each reference comment uses one line or not. If this |
| 287 | + # is `true`, `:max_line_width` is ignored for reference comment. |
285 | 288 | # @option options [Encoding] :encoding (nil) |
286 | 289 | # Encodes to the specific encoding. |
287 | 290 | def initialize(entry, options={}) |
@@ -405,24 +408,29 @@ def format_extracted_comment |
405 | 408 | end |
406 | 409 |
|
407 | 410 | def format_reference_comment |
408 | | - max_line_width = @options[:max_line_width] |
409 | 411 | formatted_reference = String.new |
410 | | - if not @entry.references.nil? and not @entry.references.empty? |
411 | | - formatted_reference << REFERENCE_COMMENT_MARK |
412 | | - line_width = 2 |
413 | | - @entry.references.each do |reference| |
414 | | - if max_line_width > 0 and |
| 412 | + if @options[:use_one_line_per_reference] |
| 413 | + @entry.references&.each do |reference| |
| 414 | + formatted_reference << "#{REFERENCE_COMMENT_MARK} #{reference}\n" |
| 415 | + end |
| 416 | + else |
| 417 | + max_line_width = @options[:max_line_width] |
| 418 | + if not @entry.references.nil? and not @entry.references.empty? |
| 419 | + formatted_reference << REFERENCE_COMMENT_MARK |
| 420 | + line_width = 2 |
| 421 | + @entry.references.each do |reference| |
| 422 | + if max_line_width > 0 and |
415 | 423 | line_width + reference.size > max_line_width |
416 | | - formatted_reference << "\n" |
417 | | - formatted_reference << "#{REFERENCE_COMMENT_MARK} #{reference}" |
418 | | - line_width = 3 + reference.size |
419 | | - else |
420 | | - formatted_reference << " #{reference}" |
421 | | - line_width += 1 + reference.size |
| 424 | + formatted_reference << "\n" |
| 425 | + formatted_reference << "#{REFERENCE_COMMENT_MARK} #{reference}" |
| 426 | + line_width = 3 + reference.size |
| 427 | + else |
| 428 | + formatted_reference << " #{reference}" |
| 429 | + line_width += 1 + reference.size |
| 430 | + end |
422 | 431 | end |
| 432 | + formatted_reference << "\n" |
423 | 433 | end |
424 | | - |
425 | | - formatted_reference << "\n" |
426 | 434 | end |
427 | 435 | formatted_reference |
428 | 436 | end |
|
0 commit comments