[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kdevelop-bugs
Subject:    [Bug 159305] New: Feature Request: Customizable dOxygen comments
From:       Daniel B <theredbaran () gmail ! com>
Date:       2008-03-14 13:30:33
Message-ID: 20080314143032.159305.theredbaran () gmail ! com
[Download RAW message or body]

------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
         
http://bugs.kde.org/show_bug.cgi?id=159305         
           Summary: Feature Request: Customizable dOxygen comments
           Product: kdevelop
           Version: 3.5.1
          Platform: SuSE RPMs
        OS/Version: Linux
            Status: UNCONFIRMED
          Severity: wishlist
          Priority: NOR
         Component: general
        AssignedTo: kdevelop-bugs kdevelop org
        ReportedBy: theredbaran gmail com


Version:           3.5.1 (using KDE 3.5.7)
Installed from:    SuSE RPMs
OS:                Linux

In the project that I'm currently working on, our coding standards have us writing \
dOxygen comments like this: /**
 * \brief This function runs the Foo algorithm on the Bar data
 *
 * More detailed description
 *
 * \param Bar is the Binary Algebraic Recursive data that Foo needs to complete
 * \return An int value that is equal to the meaning of life, or 42
 */
int Foo(s_BarData Bar) const;

There are a couple things that are different between that and what KDevelop currently \
inserts: 1. We use a "\" instead of an " "
2. We always put in a brief

It would be nice if those kinds of things could be specified by a user. I could also \
see people wanting to add things like: \author $MyName
\date $TodaysDate or \date $MM/$DD/$YYYY (the later would be more customizable)
where those are macros that expand.

One way to accomplish some of this is to have a text file that is a template. It \
could look something like this: /**
 * \brief $Function
 * \author $MyName
 * \data $MM/$DD/$YYYY
 *
 * \param $param
 * \return
 */

_______________________________________________
KDevelop-bugs mailing list
KDevelop-bugs@kdevelop.org
https://barney.cs.uni-potsdam.de/mailman/listinfo/kdevelop-bugs


[prev in list] [next in list] [prev in thread] [next in thread]