[macro-support-review] Documenting macro configurations

Rodrigo Souto
1 parent 62be815f
Showing 1 changed file with 13 additions and 1 deletions Show diff stats
lib/noosfero/plugin/macro.rb
@@ -3,8 +3,20 @@ class Noosfero::Plugin::Macro
   attr_accessor :context
   class << self
+    # Options
+    #
+    # [:icon_path]  Determines the path to icon to be used in the button on
+    #               tinymce
+    # [:title]      Former name of the macro
+    # [:skip_dialog]  Skip configuration dialog on tinymce
+    # [:js_files]     Javascripts that should be included on tinymce
+    # [:css_files     Css files that should be included on tinymce
+    # [:generator]    Javascript code that will be loaded when the macro button
+    #                 is clicked on tinymce
+    # [:params]       Hash of macro fields that the user might configure
+    #
     def configuration
-      #    {:generator => ''}
+      {}
     end
     def plugin
	@@ -3,8 +3,20 @@ class Noosfero::Plugin::Macro		@@ -3,8 +3,20 @@ class Noosfero::Plugin::Macro
3	attr_accessor :context	3	attr_accessor :context
4		4
5	class << self	5	class << self
		6	+ # Options
		7	+ #
		8	+ # [:icon_path] Determines the path to icon to be used in the button on
		9	+ # tinymce
		10	+ # [:title] Former name of the macro
		11	+ # [:skip_dialog] Skip configuration dialog on tinymce
		12	+ # [:js_files] Javascripts that should be included on tinymce
		13	+ # [:css_files Css files that should be included on tinymce
		14	+ # [:generator] Javascript code that will be loaded when the macro button
		15	+ # is clicked on tinymce
		16	+ # [:params] Hash of macro fields that the user might configure
		17	+ #
6	def configuration	18	def configuration
7	- # {:generator => ''}	19	+ {}
8	end	20	end
9		21
10	def plugin	22	def plugin