2 |
2 |
3 # Copyright (c) 2021 - 2022 Detlev Offenbach <detlev@die-offenbachs.de> |
3 # Copyright (c) 2021 - 2022 Detlev Offenbach <detlev@die-offenbachs.de> |
4 # |
4 # |
5 |
5 |
6 """ |
6 """ |
7 Module implementing the docstring generator for the 'sphinxdoc' style. |
7 Module implementing the docstring generator for the 'googledoc' style. |
8 """ |
8 """ |
9 |
9 |
10 |
10 |
11 def generateGoogleDoc(functionInfo, editor): |
11 def generateDoc(functionInfo, editor): |
12 """ |
12 """ |
13 Function to generate the docstring line list iaw. Sphinx documentation |
13 Function to generate the docstring line list iaw. Google documentation |
14 style. |
14 style. |
15 |
15 |
16 Note: Text is created with DESCRIPTION placeholders for descriptions and |
16 Note: Text is created with DESCRIPTION placeholders for descriptions and |
17 TYPE placeholders for type information |
17 TYPE placeholders for type information |
18 |
18 |