From df0eeba783d78516ee0e911592b7773fbbc1dcf3 Mon Sep 17 00:00:00 2001
From: Jonathan Hefner <jonathan@hefner.pro>
Date: Mon, 25 Sep 2023 12:00:51 -0500
Subject: [PATCH] Refactor debug messages

This factors `debug_msg` calls into `render_file`, which displays the
file output path.  Each output path indicates what kind of documentation
was rendered.  For example, files output to `classes/` contain class
documentation.
---
 lib/sdoc/generator.rb | 22 ++++++----------------
 1 file changed, 6 insertions(+), 16 deletions(-)

diff --git a/lib/sdoc/generator.rb b/lib/sdoc/generator.rb
index 582625fa..fd61cd66 100644
--- a/lib/sdoc/generator.rb
+++ b/lib/sdoc/generator.rb
@@ -117,12 +117,12 @@ def index
 
   protected
   ### Output progress information if debugging is enabled
-  def debug_msg( *msg )
-    return unless $DEBUG_RDOC
-    $stderr.puts( *msg )
+  def debug_msg(*msg)
+    $stderr.puts(*msg) if $DEBUG_RDOC
   end
 
   def render_file(template_path, output_path, context = nil)
+    debug_msg "Rendering #{output_path}"
     return if @options.dry_run
 
     result = SDoc::Renderer.new(context, @options).render(template_path)
@@ -133,33 +133,23 @@ def render_file(template_path, output_path, context = nil)
     output_path.write(result)
   end
 
-  ### Create index.html with frameset
+  ### Generate index.html
   def generate_index_file
-    debug_msg "Generating index file in #{@output_dir}"
     render_file("index.rhtml", "index.html", index)
   end
 
   ### Generate a documentation file for each class
   def generate_class_files
-    debug_msg "Generating class documentation in #{@output_dir}"
-    @classes.each do |klass|
-      debug_msg "  rendering #{klass.path}"
-      render_file("class.rhtml", klass.path, klass)
-    end
+    @classes.each { |klass| render_file("class.rhtml", klass.path, klass) }
   end
 
   ### Generate a documentation file for each file
   def generate_file_files
-    debug_msg "Generating file documentation in #{@output_dir}"
-    @files.each do |file|
-      debug_msg "  rendering #{file.path}"
-      render_file("file.rhtml", file.path, file)
-    end
+    @files.each { |file| render_file("file.rhtml", file.path, file) }
   end
 
   ### Generate file with links for the search engine
   def generate_file_links
-    debug_msg "Generating search engine index in #{@output_dir}"
     render_file("file_links.rhtml", "panel/file_links.html", @files)
   end