Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1# -*- coding: utf-8 -*- 

2""" 

3@file 

4@brief This file is to compare different documentation style. 

5""" 

6 

7 

8def f1(a, b): 

9 """ 

10 Addition 1 

11 

12 @param a parameter a 

13 @param b parameter b 

14 @return ``a+b`` 

15 """ 

16 return a + b 

17 

18 

19def f2(a, b): 

20 """Addition 2 

21 @param a parameter a 

22 @param b parameter b 

23 @return ``a+b``""" 

24 return a + b 

25 

26 

27def f3(a, b): 

28 """ 

29 Addition 3 

30 

31 :param a: parameter a 

32 :param b: parameter a 

33 :returns: ``a+b`` 

34 """ 

35 return a + b 

36 

37 

38def f4(a, b): 

39 """Addition 4 

40 

41 :param a: parameter a 

42 :param b: parameter a 

43 

44 :returns: ``a+b``""" 

45 return a + b 

46 

47 

48def f5(a, b): 

49 """ 

50 Addition 5 

51 

52 Parameters 

53 ---------- 

54 

55 a: parameter a 

56 

57 b: parameter b 

58 

59 Returns 

60 ------- 

61 ``a+b`` 

62 """ 

63 return a + b 

64 

65 

66def f6(a, b): 

67 """ 

68 Addition 6 

69 

70 Args: 

71 a: parameter a 

72 b: parameter b 

73 

74 Returns: 

75 ``a+b`` 

76 """ 

77 return a + b