WRK Documentation

By Michael Schöbel

The source code documentation generator tool Doxygen can be used to generate a collection of HTML pages which allow easy navigation through large amount of source code files.

We created a WRK documentation using doxygen to allow a better exploration of the Windows Research Kernel source code.


Generated call graphs show functions called by a specific base function.

Include dependencies between different header definition files can be visualized as well.

The documenation was generated using a small doxygen filter for .C, .H and .ASM files. Comments written in Microsoft-style (/*++ ... --*/) were transformed into the doxygen specific format (/*! ... */). For assembler functions, C-like stub functions are generated which allows doxygen to link to this functions. Doxygen generates roughly 5 Gbyte of images and HTML files for the whole Windows Research Kernel source tree.

UPDATE:

Doxygen Config File for Doxygen 1.4.6
WRK Filter

The doxygen filter for the WRK source code could be improved. :)

November 7, 2007 | Filed Under Misc, Reference

5 Comments 

Comments

5 Responses to “WRK Documentation”

  1. OneClick on March 3rd, 2008 14:21

    Can you show me the doxygen config file?
    When I use doxygen to generat the callgraphs , some errors occured. Can you help me solve this problem?
    my config file is in here:
    http://myfilelib.googlepages.com/doxygen.rar

  2. Michael Schöbel on March 3rd, 2008 15:51

    Hi,
    I just uploaded the Doxygen configuration file and the source code filter. But I did not try it with version 1.5.2.

    Maybe you should set CREATE_SUBDIRS to YES.

  3. OneClick on March 4th, 2008 06:26

    Thank you for your help.
    I have find the solution this morning. My file system is Fat32. It can not hold too many files. When I convert the file system to NTFS, every thing is OK.

  4. Windows Research Kernel @ HPI - news, howtos and labdescriptions » WRK at MSR Faculty Summit 2008 on August 9th, 2008 21:41

    [...] are probably familiar with Michael’s Doxygen based hyper-linked source code repository of the WRK that is available to all academic institutions. In addition to that, we use Phoenix, a [...]

  5. Introducing PXR: A Cross-Referencing Documentation Compiler : Windows Research Kernel @ HPI on September 22nd, 2010 15:26

    [...] some time ago, Michael posted an article about our filter for the Doxygen documentation compiler. While Doxygen is a great tool for [...]