The Wumpus Information Retrieval System – Documentation
Author: Stefan Buettcher (firstname.lastname@example.org)
Last change: 2007-07-14
The Wumpus documentation is still under construction.
If you have any questions that cannot be answered
from the files available here or from the code itself, feel free to send me an
e-mail (stefan at wumpus-search dot org).
Using the Wumpus system
Use the links below to get a general introduction in how to use Wumpus.
In addition, I've uploaded some slides that
I used for a tutorial I gave to the IR group at the University of Waterloo.
Understanding the Wumpus internals and digging into the code
In general, you will find lots of comments in the Wumpus code. If the .cpp file
that contains the code for which you want to read documentation does not contain
the information you are looking for, check the corresponding .h file. It should
tell you what a class is good for, what a particular method is good for, etc.
However, it might be easier for you to understand what is going on if you get
a general introduction to the Wumpus internals before you start reading the actual
code. The links below provide that kind of introduction.