From 536b39c961854438ecbe1b58289cfb4363e14c7c Mon Sep 17 00:00:00 2001
From: Petr Korolev <sky4winder@gmail.com>
Date: Fri, 22 May 2015 13:37:06 +0300
Subject: [PATCH] add doc

---
 lib/github_changelog_generator/generator.rb | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/lib/github_changelog_generator/generator.rb b/lib/github_changelog_generator/generator.rb
index f076f4b..fdc0943 100644
--- a/lib/github_changelog_generator/generator.rb
+++ b/lib/github_changelog_generator/generator.rb
@@ -28,6 +28,10 @@ module GitHubChangelogGenerator
       title_with_number
     end
 
+    # Encapsulate characters to make markdown look as expected.
+    #
+    # @param [String] string
+    # @return [String] encapsulated input string
     def encapsulate_string(string)
       string.gsub! '\\', '\\\\'