Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for Doxygen #120

Closed
zurdala opened this issue Apr 23, 2020 · 5 comments · Fixed by #272
Closed

Add support for Doxygen #120

zurdala opened this issue Apr 23, 2020 · 5 comments · Fixed by #272

Comments

@zurdala
Copy link

zurdala commented Apr 23, 2020

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

@NilsJPWerner
Copy link
Owner

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

@zurdala
Copy link
Author

zurdala commented Apr 29, 2020

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

@zurdala
Copy link
Author

zurdala commented Apr 30, 2020

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

@NilsJPWerner
Copy link
Owner

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

@zurdala
Copy link
Author

zurdala commented May 4, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants