Ice Docs

Generating Documentation with Doxygen

Using Doxygen, version 1.8.15 or later, you can generate an API reference for your Slice definitions, including their doc comments. The Slice API reference is Doxygen's output for Ice's own Slice files.

Create a Doxyfile with doxygen -g, and set these three settings in it:

  • OPTIMIZE_OUTPUT_SLICE = YES, so that Doxygen tailors its output to Slice.
  • INPUT, to your Slice files or the directories that hold them.
  • INCLUDE_PATH, to the directories your Slice files include from.

Then run doxygen in the directory that holds the Doxyfile.

To link your reference to ZeroC's for the Ice types your Slice files use, download the tag file and add it to TAGFILES:

TAGFILES = slice.tag=https://code.zeroc.com/ice/3.8/api/slice