Fork me on GitHub

Project Notes

doxygen

Installing and testing doxygen for c++ source documentation generation on MacOSX.

Compiling from Source (MacOSX)

$ git clone https://github.com/doxygen/doxygen.git
$ cd doxygen
$ mkdir build
$ cd build
$ cmake -G "Unix Makefiles" ..
$ make

All ran successfully (a few compiler warnings) and the executable is available in build/bin/doxygen.

Testing

For a quick test, I’m configuring and running doxygen on the LCK: exception_handling example:

$ cd ../exception_handling
$ doxygen -g


Configuration file `Doxyfile' created.

Now edit the configuration file and enter

  doxygen Doxyfile

to generate the documentation for your project

I made only three changes to the default doxygen file:

PROJECT_NAME           = "LCK Exception Handling"
OUTPUT_DIRECTORY       = doc
GENERATE_LATEX         = NO

Then ran it:

$ doxygen Doxyfile

It generated the HTML documentation available here

hero_image

Credits and References

About LCK#32 C++
Project Source on GitHub Return to the Project Catalog

This page is a web-friendly rendering of my project notes shared in the LittleCodingKata GitHub repository.

LittleCodingKata is my collection of programming exercises, research and code toys broadly spanning things that relate to programming and software development (languages, frameworks and tools).

These range from the trivial to the complex and serious. Many are inspired by existing work and I'll note credits and references where applicable. The focus is quite scattered, as I variously work on things new and important in the moment, or go back to revisit things from the past.

This is primarily a personal collection for my own edification and learning, but anyone who stumbles by is welcome to borrow, steal or reference the work here. And if you spot errors or issues I'd really appreciate some feedback - create an issue, send me an email or even send a pull-request.