example_javadoc.py.patch

# Patch generated by Pyment v0.4.0

--- a/example.py
+++ b/example.py
@@ -1,103 +1,96 @@
 def func1(param1: str, param2='default val'):
-    '''Description of func with docstring javadoc style.
+    """Description of func with docstring javadoc style.
+
+    @param param1: descr of param
+    @type param1: str
+    @param param2:  (Default value = 'default val')
+    @return: some value
+    @raise KeyError: raises a key exception
+
+    """
+    pass
+
+def func2(param1, param2='default val2') -> list:
+    """Description of func with docstring reST style.
 
     @param param1: descr of param
     @type param1: type
+    @param param2:  (Default value = 'default val2')
     @return: some value
-    @raise KeyError: raises a key exception
+    @rtype: list
+    @raise keyError: raises exception
 
-    '''
-    pass
-
-def func2(param1, param2='default val2') -> list:
-    '''Description of func with docstring reST style.
-
-    :param param1: descr of param
-    :type param1: type
-    :returns: some value
-    :raises keyError: raises exception
-
-    '''
+    """
     pass
 
 def func3(param1, param2='default val'):
-    '''Description of func with docstring groups style.
+    """Description of func with docstring groups style.
 
-    Params: 
-        param1 - descr of param
+    @param param1: descr of param
+    @param param2:  (Default value = 'default val')
+    @return: some value
+    @raise keyError: raises key exception
+    @raise TypeError: raises type exception
 
-    Returns:
-        some value
-
-    Raises:
-        keyError: raises key exception
-        TypeError: raises type exception
-
-    '''
+    """
     pass
 
 class SomeClass(object):
-    '''My class.
-    '''
+    """My class."""
     def method(self, prm):
-        '''description'''
+        """description
+
+        @param prm: 
+
+        """
         pass
 
     def method2(self, prm1, prm2='defaultprm'):
+        """
+
+        @param prm1: 
+        @param prm2:  (Default value = 'defaultprm')
+
+        """
         pass
 
     def method_numpy(self):
-        """
-        My numpydoc description of a kind
+        """My numpydoc description of a kind
         of very exhautive numpydoc format docstring.
 
-        Parameters
-        ----------
-        first : array_like
-            the 1st param name `first`
-        second :
-            the 2nd param
-        third : {'value', 'other'}, optional
-            the 3rd param, by default 'value'
-
-        Returns
-        -------
-        string
-            a value in a string
-
-        Raises
-        ------
-        KeyError
-            when a key error
-        OtherError
-            when an other error
+        @param first: the 1st param name `first`
+        @type first: array_like
+        @param second: the 2nd param
+        @param third: the 3rd param, by default 'value'
+        @type third: {'value', 'other'}, optional
+        @return: a value in a string
+        @rtype: string
+        @raise KeyError: when a key error
+        @raise OtherError: when an other error
 
         See Also
         --------
         a_func : linked (optional), with things to say
                  on several lines
         some blabla
-
+        
         Note
         ----
         Some informations.
-
+        
         Some maths also:
         .. math:: f(x) = e^{- x}
-
         References
         ----------
         Biblio with cited ref [1]_. The ref can be cited in Note section.
-
+        
         .. [1] Adel Daouzli, Sylvain Saïghi, Michelle Rudolph, Alain Destexhe,
            Sylvie Renaud: Convergence in an Adaptive Neural Network:
            The Influence of Noise Inputs Correlation. IWANN (1) 2009: 140-148
-
         Examples
         --------
         This is example of use
         >>> print "a"
         a
-
         """
         pass