kicad-developers team mailing list archive

Thread
Date

Re: How can I use Doxygen to understand Kicad Source code?

To: kicad-developers@xxxxxxxxxxxxxxxxxxx
From: Dick Hollenbeck <dick@xxxxxxxxxxx>
Date: Sun, 26 Feb 2012 23:28:54 -0600
Authentication-results: mr.google.com; spf=pass (google.com: domain of dick@xxxxxxxxxxx designates 10.101.187.13 as permitted sender) smtp.mail=dick@xxxxxxxxxxx; dkim=pass header.i=dick@xxxxxxxxxxx
In-reply-to: <4F48F856.3010801@djsbriscoe.vispa.com>
User-agent: Mozilla/5.0 (X11; U; Linux x86_64; en-US; rv:1.9.2.27) Gecko/20120216 Thunderbird/3.1.19

On 02/25/2012 09:03 AM, David J S Briscoe wrote:
> Hi,
> I would in the fullness of time like to contribute to Kicad source code.
> But first I have to learn C++. How can I supplement my learning by using
> Kicad source as an example?
> In particular how do I properly use Doxygen to help in my understanding?
> Thank you.
>
> David.

Install it.  
Put it into your PATH.
Verify that it is visible on the command line, this better run:
$ doxygen --help

Then simply do:

a KiCad cmake build target invocation using make out of the normal KiCad source tree:

$ make doxygen-docs

Find the generated html files in Documentation/*/index.html

References

How can I use Doxygen to understand Kicad Source code?
From: David J S Briscoe, 2012-02-25