Doxygen and Xcode. |
26 September 2004 |
I have been playing around with HeaderDoc in Xcode. I don't like it.
It makes my header files too large and messy. I like my header
files to be simple, so I started looking for something else.
I came across Doxygen
(it's not like I haven't seen it before...)
and decided to use it instead. I downloaded Doxygen-1.3.8
and installed it by dragging the application from the disk image to my Applications folder.
It's quite simple to use, add comments to your code while keeping in mind some
of the common tags (\brief, \param and \return for example).
I can put these comments in my implementation file, in my header file or
nowhere at all since Doxygen can create documentation from plain code.
I found one very helpful article about Doxygen and Xcode from
macdevcenter.com
by Adam Behringer.
Using the utility in the downloaded disk image you can setup a documentation project,
and with a custom build step in Xcode you can have the documentation generated automatically
at build time.Now please go and read Adam Behringer's article
for more information!
(I'm not putting the instructions here, I would just be copying the article and that would be bad.)
|
