Uni OS

ObjcDoc - Main

v My Homepage
 > Fun & Games
 > Local Documents
 v Projects
  > GToolKit
  v ObjcDoc
  > mfg
  > rtfdtohtml
 > Talks
 > More Links
  Uni Osnabrück
 My FTP-Area

What is ObjcDoc?

ObjcDoc is a tool designed to aid programmers in documenting Objective-C class libraries. It can parse Objective-C source code (both include and implementation files) and will create HTML output files containing class documentation extracted from special comments inside the source code (somewhat similar to Javadoc).

Additionally, ObjcDoc can also create a class and protocol index as well as a view of the complete class inheritance hierarchy with links to the individual documentation files.

For a complete description, read the README file and the ObjcDoc manual page. The ChangeLog is also available.

Example Output

To get an impression of what the output looks like, you can take a look at the class documentation for the GToolKit Objective-C library. This is the HTML documentation generated by ObjcDoc from the actual source code and header files (which you can find here).

Example documentation


You can always find the source code of the latest version (and some of the earlier releases) on the download page. There are also RPM packages for Linux. Alas, I do not know how to build Debian packages and do not have Debian packaging tools.

Go to the download page

Currently supported Platforms

Probably any Unix-like platform, although Windows should work as well. You will need Perl (at least version 5, maybe 5.6, I haven't checked this) and a Unix-style Shell to run the configure script.

I have tested the program successfully on Linux and Mac OS X so far.

I think I've found a Bug. What can I do?

Send a detailed description of the problem to my email address given below and I will have a look at it. You may also include a patch, of course, if you think you can fix the problem yourself.

Todo List

This is a small (and incomplete) list of things that need to be done:
  • empty lines within comments should be recognized as paragraph breaks, unless they are part of example code (which is not easy to detect)
  • support for output formats other than HTML (like LaTeX or plain text)
  • make the input file encoding selectable?


Copyright © 1996-1997 Holger Ludwig,
Copyright © 1998-2002 Elmar Ludwig.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

09-09-2005  Copyright © Elmar Ludwig <Elmar.Ludwig@uos.de>