Install EcloxĮclox is an Eclipse plug-in that I found out about from this post. I’m pretty sure (but not positive) my challenge was not in the version of graphviz. I’m not completely sure because I was fiddling around trying to get graphical views to work within Doxygen. Dot seems to work with either of the versions. From what I can tell, the only thing used is the dot command line tool. Install GraphVizĪs pointed out in this post: Graphviz is open source software to create graphs using the dot language. I copied Doxygen.app into the Applications folder. The Stepsĭoxygen can be installed from this link. The examples are located here in this GitHub repository. Each contain a Documentation folder where you can view Doxygen’s output (open up the index.html file). I peppered the source with Doxygen commands. I provided example Eclipse projects that use the NRF51 SDK in this GitHub repository.
LED_TEST is a very simple project I will be using to test the LED I have laid out on the LadybugBlueLite PCB.
Doxygen wizard graphviz mac os x#
The goal of this post is to add documentation to an Eclipse project (running on Mac OS X 10.10) – LED_TEST. I clearly saw the value after Ron walked us through one of his projects that had been “Doxygenated.” The Goal
Doxygen wizard graphviz how to#
Thanks to Ron Sousa for showing us how to use Doxygen and Graphviz. Thank you Erich for your well written advice. I found this post by Erich Styger to be exceptionally helpful in understanding what was going on. I like having the documentation within the same location as the source. In our embedded systems section of Contextual Electronics, Ron showed us how he uses Doxygen and Graphviz to document code. However the name should work with more context to understand why a program was written the way it is and why that function is needed. What a waste of time and space! Certainly, the name of the function is super important to documentation. I don’t mean the kind of comment that I run across all too often:Ī comment that repeats the name of the function. An added benefit is if the documentation is well thought out, it greatly helps me figure out which way I should go within the variety of options to create code for the task at hand. I appreciate documenting my code mostly because I forget how I wrote it – and sometimes worse – why I wrote it.
0 kommentar(er)
