add Exists tags

NilsJPWerner · Mar 28, 2024 · 71c1647 · 71c1647
1 parent 6c99ae3
commit 71c1647
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/src/docstring/templates/doxygen-notypes.mustache b/src/docstring/templates/doxygen-notypes.mustache
@@ -3,22 +3,30 @@
 @brief {{summaryPlaceholder}}
 
 {{extendedSummaryPlaceholder}}
+{{#parametersExist}}
 
 {{#args}}
 @param {{var}}: {{descriptionPlaceholder}}
 {{/args}}
 {{#kwargs}}
 @param {{var}}: {{descriptionPlaceholder}}. Defaults to {{&default}}.
 {{/kwargs}}
+{{/parametersExist}}
+{{#returnsExist}}
 
 {{#returns}}
-@return {{descriptionPlaceholder}}
+@return: {{descriptionPlaceholder}}
 {{/returns}}
+{{/returnsExist}}
+{{#exceptionsExist}}
 
 {{#exceptions}}
-@exception {{descriptionPlaceholder}}
+@exception: {{descriptionPlaceholder}}
 {{/exceptions}}
+{{/exceptionsExist}}
+{{#yieldsExist}}
 
 {{#yields}}
-@returns {{descriptionPlaceholder}}
+@returns: {{descriptionPlaceholder}}
 {{/yields}}
+{{/yieldsExist}}
diff --git a/src/docstring/templates/doxygen.mustache b/src/docstring/templates/doxygen.mustache
@@ -3,22 +3,30 @@
 @brief {{summaryPlaceholder}}
 
 {{extendedSummaryPlaceholder}}
+{{#parametersExist}}
 
 {{#args}}
 @param {{var}} ({{typePlaceholder}}): {{descriptionPlaceholder}}
 {{/args}}
 {{#kwargs}}
 @param {{var}} ({{typePlaceholder}}, optional): {{descriptionPlaceholder}}. Defaults to {{&default}}.
 {{/kwargs}}
+{{/parametersExist}}
+{{#returnsExist}}
 
 {{#returns}}
 @return ({{typePlaceholder}}): {{descriptionPlaceholder}}
 {{/returns}}
+{{/returnsExist}}
+{{#exceptionsExist}}
 
 {{#exceptions}}
 @exception {{type}}: {{descriptionPlaceholder}}
 {{/exceptions}}
+{{/exceptionsExist}}
+{{#yieldsExist}}
 
 {{#yields}}
 @returns {{typePlaceholder}}: {{descriptionPlaceholder}}
 {{/yields}}
+{{/yieldsExist}}