| OLD | NEW |
| (Empty) | |
| 1 #!/usr/bin/env python |
| 2 # encoding: utf-8 |
| 3 ## @brief Sample documentation the arbitrary section handling. |
| 4 # |
| 5 #Related to issue #7 [1]. |
| 6 # |
| 7 #[1]: https://github.com/Feneric/doxypypy/issues/7 |
| 8 # |
| 9 |
| 10 |
| 11 |
| 12 ## @brief A simple function of two arguments. |
| 13 # |
| 14 # This function takes two arguments, but does absolutely nothing with them. |
| 15 # However, it sends out a friendly greeting to the world. |
| 16 # |
| 17 # |
| 18 # @param arg1 The first argument |
| 19 # @param arg2 The second argument |
| 20 # |
| 21 # @return |
| 22 # A string stating "Hello World" |
| 23 # |
| 24 # @b Examples |
| 25 # @code |
| 26 # >>> function(1, 2) |
| 27 # "Hello World" |
| 28 # >>> function('a', 'b') |
| 29 # "Hello World" |
| 30 # @endcode |
| 31 # |
| 32 # @par Intent |
| 33 # The intent is to demonstrate sections like this one within docstrings. |
| 34 # How they behave with multiple lines. |
| 35 # @par |
| 36 # And how they behave with multiple paragraphs. |
| 37 # That contain multiple lines. |
| 38 # |
| 39 # Paragraphs stading by themselves without indention, should be left alone. |
| 40 # |
| 41 def function(arg1, arg2): |
| 42 return "Hello World" |
| OLD | NEW |