autoDocstring icon indicating copy to clipboard operation
autoDocstring copied to clipboard

Add support for Doxygen

Open zurdala opened this issue 5 years ago • 5 comments

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

zurdala avatar Apr 23 '20 07:04 zurdala

You could try to recreate the docstring format with the custom docstring templates: https://github.com/NilsJPWerner/autoDocstring#custom-docstring-templates

NilsJPWerner avatar Apr 23 '20 17:04 NilsJPWerner

That's great! I will try in the next days and report back. If it works, I will post the snippet here

zurdala avatar Apr 29 '20 08:04 zurdala

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}}

zurdala avatar Apr 30 '20 12:04 zurdala

If you create a pr I will merge it in as a standard option.

NilsJPWerner avatar May 02 '20 05:05 NilsJPWerner

Great! Let me test it for a couple of days before doing that

zurdala avatar May 04 '20 07:05 zurdala