On Wed, Mar 22, 2017 at 04:08:40PM -0400, Wayne Stambaugh wrote:
> On 3/22/2017 1:14 PM, Chris Pavlina wrote:
> > On Wed, Mar 22, 2017 at 01:05:48PM -0400, Wayne Stambaugh wrote:
> >> A lot of this is a product of habit and copy & paste. It's not uncommon
> >> for derived classes to have the same
On 3/22/2017 1:14 PM, Chris Pavlina wrote:
> On Wed, Mar 22, 2017 at 01:05:48PM -0400, Wayne Stambaugh wrote:
>> A lot of this is a product of habit and copy & paste. It's not uncommon
>> for derived classes to have the same header doc comments as the base
>> class even though this is not necessar
On Wed, Mar 22, 2017 at 01:05:48PM -0400, Wayne Stambaugh wrote:
> A lot of this is a product of habit and copy & paste. It's not uncommon
> for derived classes to have the same header doc comments as the base
> class even though this is not necessary either. I'm OK with changing
> this as we upd
I'm going to side with Chris on this issue. Using a first sentence for
the brief description, followed by an empty line, and then an optional
detailed paragraph is certainly much more readable than using the
doxygen keywords.
On 3/22/2017 12:14 PM, Chris Pavlina wrote:
> I really hate @brief and
A lot of this is a product of habit and copy & paste. It's not uncommon
for derived classes to have the same header doc comments as the base
class even though this is not necessary either. I'm OK with changing
this as we update headers. I would rather avoid the one giant commit
with all of the d
Yes I agree with you here, I need to figure out how to update my template
because I always end up deleting those.
On Wed, Mar 22, 2017 at 11:14 AM, Chris Pavlina
wrote:
> I really hate @brief and @details. Doxygen can do that automatically,
> making the brief docstring the first sentence and the
I really hate @brief and @details. Doxygen can do that automatically,
making the brief docstring the first sentence and the details one the
whole text. It makes for a doc comment that is much more readable in the
header itself, which is honestly how I read them most of the time.
On Wed, Mar 22, 20
I think these are useless - the function name is right there anyway
unless the comment is absolutely enormous. These are just places for
doc-rot to creep if the function name changes.
I sometimes add them, but usually just to maintain consistency in a file.
Over 400 classes have a similar "* Clas
Hi Chris,
I agree with this and would also suggest that there are more Doxygen tags
we can use if desired.
In fact, I use a plugin for my editor that generates Doxygen templates
automatically if I type "/**" above a line of code:
/**
* @brief [brief description]
* @details [long description]
*
Hi all and mostly Wayne,
I notice that a lot of our older documentation comments redundantly list
the name of the function they document:
/**
* Function IsVoid
* @return true if the field value is void (no text in this field)
*/
bool IsVoid() const
I don't see any purpose
10 matches
Mail list logo
