Changes between Initial Version and Version 1 of RefactoringSteps/GenerateFunctionSpecification

Timestamp:

Feb 19, 2012, 11:48:34 PM (12 years ago)

Author:

manualwiki

Comment:

--

RefactoringSteps/GenerateFunctionSpecification

@@ +1 @@
+= Generate function specification =
+
+The “generate function specification” transformation calculates the specification of the selected function and insert the -spec directive in front of the function.
+
+Inserting specification for function {{{f}}}:
+
+{{{
+j(X, ok) ->
+   X + 2.
+}}}
+
+Result:
+
+{{{
+-spec(j(float()|int(),atom())
+   ->float()|int())
+
+j(X, ok) ->
+   X + 2.
+}}}
+
+== Side conditions ==
+
+ * There is no side condition to use this transformation.
+
+
+== Transformation steps and compensations ==
+
+ 1. Calculates the specification of the function.
+
+ 2. Inserts the specification.