kicad-developers team mailing list archive
-
kicad-developers team
-
Mailing list archive
-
Message #38461
Re: Trace variables documentation
John,
I merged your patch.
Thanks,
Wayne
On 11/26/2018 11:39 AM, John Beard wrote:
> On Mon, Nov 26, 2018 at 2:06 PM Wayne Stambaugh <stambaughw@xxxxxxxxx> wrote:
>
>> I did it so I didn't have to grep the entire source tree to find
>> the trace string.
>
> Indeed!
>
>> I can see the utility of adding the strings to the trace variable docs.
>> I agree that digging through the source file can be time consuming.
>
> I have added these in the attached patch, and linked to the source
> from the testing.md dev docs. (This patch is contingent on the zoom
> patches).
>
>> I'm not opposed to defining the doxygen group markers in place but my
>> guess is devs will not be consistent about it so the trace_helpers
>> header file will ensure they get added to the group. That is one of the
>> reasons I started merging them into a single file. That process is not
>> complete.
>
> Whatever keeps maintenance simpler is best, IMO. I was just noting
> that it is not required to define things together to document
> together. Will all masks, even in the 3D plugin, which has its own
> large set, be in the common include?
>
>> I doubt that compiling will become a huge issue but I could be wrong
>> about that.
>
> For now, certainly, it's not a massive issue, especially if you touch
> libcommon or Git and invoke a re-link anyway!
>
> Cheers,
>
> John
>
References