← Back to team overview

kicad-developers team mailing list archive

Re: [PATCH] Small correction of documentation in BOARD_CONNECTED_ITEM::GetClearance()

 

Derived methods shouldn't have Doxygen comments unless they differ from
the base class which does not appear to be so in this case.  Doxygen
automagically populates the derived method information from the base
class documentation.  I committed your patch as is but at some point
this should probably be fixed.  Thank you for your contribution to KiCad.

Cheers,

Wayne

On 6/27/2017 4:44 PM, Simon Küppers wrote:
> I tried to be consistent with documentation of overriding functions
> TRACK::GetClearance() and VIA::GetClearance()
> 
> See
> https://github.com/KiCad/kicad-source-mirror/blob/master/pcbnew/class_track.h
> 
> Best Regards
> Simon
> 
> Am 27.06.2017 um 22:42 schrieb Wayne Stambaugh:
>> Simon,
>>
>> Since the internal units are nanometers, it might be more clear to state
>> nanometers rather than internal units.
>>
>> Thanks,
>>
>> Wayne
>>
>> On 6/27/2017 4:25 PM, Simon Küppers wrote:
>>> See attached.
>>>
>>> Best Regards
>>> Simon
>>>
>>>
>>> _______________________________________________
>>> Mailing list: https://launchpad.net/~kicad-developers
>>> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>>> Unsubscribe : https://launchpad.net/~kicad-developers
>>> More help   : https://help.launchpad.net/ListHelp
>>>
>>
>> _______________________________________________
>> Mailing list: https://launchpad.net/~kicad-developers
>> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>> Unsubscribe : https://launchpad.net/~kicad-developers
>> More help   : https://help.launchpad.net/ListHelp
>>
> 
> _______________________________________________
> Mailing list: https://launchpad.net/~kicad-developers
> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
> 


References