Added inline doc.

2016-11-11 11:17:53 +01:00 · 2016-11-11 11:17:53 +01:00 · 3e2711909a
parent 67381c07bd
commit 3e2711909a
1 changed files with 23 additions and 0 deletions
--- a/lib/notification_factory/template.rb
+++ b/lib/notification_factory/template.rb
@ -1,5 +1,28 @@
 class NotificationFactory::Template

+=begin
+
+examples how to use
+
+    message_subject = NotificationFactory::Template.new(
+      {
+        ticket: Ticket.first,
+      },
+      'de-de',
+      'some template <b><%= d "ticket.title", false %></b> <%= c "fqdn", false %>',
+      false
+    ).render
+
+    message_body = NotificationFactory::Template.new(
+      {
+        ticket: Ticket.first,
+      },
+      'de-de',
+      'some template <b><%= d "ticket.title", true %></b> <%= c "fqdn", true %>',
+    ).render
+
+=end
+
  def initialize(objects, locale, template, escape = true)
    @objects = objects
    @locale = locale || 'en-us'