AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |
Back to Blog
Comment main.c file for doxygen example12/5/2023 ![]() Here is my simple main.c source with Doxygen statements: Perhaps splash around and find out what works for your project. You may want to modify some or none of the above. Tip: When in the Advanced tab searching for a variable, go into the Custom Settings Tab and enter a search term like “DOT” to narrow down the properties to the ones you want. Without it defined, Doxygen can’t find the dot utility provided by the GraphViz install. The Advanced Tab is located at the bottom of the editor. The additional properties can be set by going to the properties in the Advanced Tab. However, I needed to set a few more properties before I could get the Diagrams to be generated. Double clicking on the LED_TEST.doxyfile brings up the Doxyfile editor Using the Doxyfile Editor The easiest way to modify the Doxyfile is through the Doxyfile UI. Ī doxyfile has been created within the LED_TEST project: As noted in the Doxygen documentation: configuration file is a free-form ASCII text file with a structure that is similar to that of a Makefile, with the default name Doxyfile. Create a DoxyfileĮach Project needs a Doxyfile. You know you have been successful if you see the version number. If you are not familiar with OS X application bundles, this wikipedia article may be helpful. Tricky part: Assuming you did like I did and copied Doxygen.app into the /Applications folder, the location of the Doxygen binary is located within Doxygen.app within the /Applications/Doxygen.app/Content/Resources. Time to tell Eclox where the Doxygen executable is located. Plug-ins are installed by going to Help->Install New Software… Risky, I know, but…I optimistically believe the gain will be worth the risk. Since December the 1st of 2009, the development and the maintenance of eclox are discontinued ! See Getting Involved to get information about development resources.ĭespite the notice, I am throwing caution to the wind and going ahead with Eclox. ![]() When I looked at the Eclox home page, I was greeted with a concerning message: 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. 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 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 Comments
Read More
Leave a Reply. |