autoDocstring
autoDocstring copied to clipboard
Add support for Doxygen
Hi I know that this is a long shot, but would it be possible to add support for doxygen? Sometimes it is required for me at work and I live would be a little bit better if this extension had support for this system of documentation If not, how could I add it myself? Thanks for the great work
You could try to recreate the docstring format with the custom docstring templates: https://github.com/NilsJPWerner/autoDocstring#custom-docstring-templates
That's great! I will try in the next days and report back. If it works, I will post the snippet here
This template seems to create a good docstring
{{! Doxygen Docstring Template }}
!
@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}}
{{#exceptions}}
@throws {{type}} {{descriptionPlaceholder}}
{{/exceptions}}
If you create a pr I will merge it in as a standard option.
Great! Let me test it for a couple of days before doing that