Bug 257709 - Allow configuring doxygen comment style when doing "Document Declaration"
Summary: Allow configuring doxygen comment style when doing "Document Declaration"
Status: CONFIRMED
Alias: None
Product: kdevelop
Classification: Applications
Component: Language Support: CPP (old) (other bugs)
Version First Reported In: git master
Platform: Unlisted Binaries Linux
: LO wishlist
Target Milestone: ---
Assignee: kdevelop-bugs-null
URL:
Keywords: junior-jobs
Depends on:
Blocks:
 
Reported: 2010-11-23 16:00 UTC by Alexander
Modified: 2017-01-12 15:03 UTC (History)
2 users (show)

See Also:
Latest Commit:
Version Fixed/Implemented In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Alexander 2010-11-23 16:00:34 UTC
Version:           SVN (using KDE 4.5.3) 
OS:                Linux

I'm using KDevelop git master 2010-11-23. I'm happy to see a recent addition of "Document Declaration" menu entry to insert doxygen comments. Invoking it, for example, on "int func(double val)" inserts:

/**
 * @brief ...
 *
 * @param val ...
 * @return int
 **/

However, our project uses a different style:
/// Brief description (the first sentence). Further description...
/// \param val description...
/// \return int

Notice the following differences:

1. The absence of @brief (we use JAVADOC_AUTOBRIEF, see http://www.stack.nl/~dimitri/doxygen/config.html#cfg_javadoc_autobrief).

2. \ instead of @ (somewhat easier to type).

3. /// instead of /** ... */ (easier to type and conserves vertical space). Sometimes we do use /** ... */ in very large comments, but we don't write * on each line.

It would be nice to be able to configure all this. There are some other formats as well, see http://www.stack.nl/~dimitri/doxygen/docblocks.html .

P.S. (Inserting "..." at the end of @brief and @param makes the user to delete it manually, so maybe it's better not to insert it at all?)

Thanks

Reproducible: Always
Comment 1 felix_mauch 2015-10-18 10:11:07 UTC
Hi there,

I know, this post is kind of old, however, I recently stood in front of the same problem and it took me quite some time to find the solution.

The doxygen completion is done through a template file which is in $(kde4-config --prefix)/share/apps/kdevcodeutils/templates/doxygen_cpp.txt

You can either adapt this file globally with root rights  or you can copy it to $(kde4-config --localprefix)/share/apps/kdevcodeutils/templates/doxygen_cpp.txt and modify it there.

For Frameworks 5 it is similar (I think without the apps/ part) and locally it is in ~/.local/share/kdevcodeutils/templates/doxygen_cpp.txt
Comment 2 Milian Wolff 2015-11-01 17:14:27 UTC
I agree, this should be easier to configure