- #Codeblocks code completion doxygen comment how to
- #Codeblocks code completion doxygen comment series
probably just strip the command and keep the rest as-is.unclear if worth separation in hover, because it might be tied to rest of the documentation (re-ordering concerns).maybe just strip (or merge into regular documentation)?.first sentence of a regular documentation)
common but usefulness in practice is unclear.findings and some initial ideas look like this: That list is gathered by counting occurrences of those commands in a codebase with lots of open-source third_party code. getting linebreaks/indent right clangd#1040Īny other use cases that you believe are important?Īs you might've noticed, this list already talks about dealing with certain doxygen commands (but not all).formatting text within comments (bold etc).treating brief/detail/warning/note differently.obtaining docs about params & return value.So first of all, what are the exact use cases you're planning to address/improve with support for doxygen parsing of comments? Couple that comes to mind: So it'd help a lot if you can provide some more information for use cases, that way we can find a nice scope for this functionality to make sure it provides most of the value and doesn't introduce an unnecessary complexity into rest of the infrastructure and also we should try not to regress indexing of projects that don't have doxygen comments. We were having some discussions internally to both understand the value proposition and its implications on the infrastructure.
#Codeblocks code completion doxygen comment series
Sorry for letting these series of patches sit around without any comments. Thanks a lot for taking a look at this (and sorry for such a delayed response). It would also be cool if we could recognize \code and translate it into markdown code What do you think? If you agree with this, I'd start with implementing the \param handling.Ĭopy/pasting the comment from review to here for having some high-level discussions. In the future we can then add support for additional commands like \warning, \return, \retval, etc. Using this information in signatureHelp for ParameterInformation/documentation could also be done in this step. I think a good way to start would be the \param commands, since parsing them correctly arguably provides the most value for users. all the commands that we don't have any special handling for \warning command, these could maybe be bold in markdown? \note command, there might be multiple of these. SymbolDocumentation(const clang::comments::FullComment&) This would be the new result of getDeclComment() we can just concatenate all children into a string. It could in theory also contain other commands, but for the start I think This is everything that comes after the \param command. The following three fields can be filled directly from ParamCommandComment ParameterInformation(const clang::comments::ParamCommandComment&) / so in the future we might make this class more generic. I know that the multiline comments would appear in the code blocks without specifying the language of the code block (writing three backticks "`" instead of three backticks and c), but I would like to keep highlighting the syntax of the C code./// There's also \tparam, which basically works in the same way but for template parameters, This is the result I get when I generate the documentation with the code block right above: This is what I have to write for the code block to appear (there seems to be issues with the symbol): /** MACRO This is what I would like to have: /** MACRO
I tried to put some examples inside the README as code blocks, but the comments used by Doxygen are multiline comments and the code blocks seem to skip the multiline comments when generating the Markdown page.
#Codeblocks code completion doxygen comment how to
I am currently documenting how to document code on one of my projects, and to do so I am writing a README.md document that I am putting as frontpage of the documentation that I generate using Doxygen 1.8.13.
0 kommentar(er)
