Closed raiseFlaymeException closed 11 months ago
Hi,
The direction
parameter in c++ indicates whether it's an IN (incoming) or OUT (outgoing) parameters. See the Doxygen Manual:
For functions one can use the @param command to document the parameters and then use [in], [out], [in,out] to document the direction. For inline documentation this is also possible by starting with the direction attribute, e.g.
void foo(int v /**< [in] docs for input parameter v. */);
Since cpp enforces type hints, it is redundant to add type hints into doc blocks, hence Doxygen also doesn't suggest to add this within the comment. Therefore, C++ docblocks never contain type hints of the function itself.
thank you, I have always used the direction the wrong way. I learned something!
Is your feature request related to a problem? Please describe.
when calling :DogeGenerate on a function like
the following comment is created:
Describe the solution you'd like
I think it would be better to have the choice to automaticly put the type of the arguments into the comment. It would generate something like:
Describe alternatives you've considered
no alternatives considered
Additional context
I just installed this pluggin on neovim 0.10 and I use g:doge_doc_standard_cpp = doxygen_cpp_comment_slash.
If anything is unclear I can try to explain (I'm not english)
thank you for your time and for this project,
Flayme