[Freerealty] Documentation- survey

[Patrick Fleming]

Hey all,
I have started looking into different methods of adding more 
documentation to the FreeRealty project files and I'm looking for some 
input.

First, I'm going through the code to add more comments that can be used 
to create the basic documents using doxygen. The result of this is that 
variables and functions are much better documented both in the code as 
well as in seperate documents.

I'm also looking at docbook style documentation which would be for 
putting together some kind of how-to without worrying about each and 
every variable, function and file.

The main differences between these two document styles seem to be that 
doxygen is very specific, pulls all of its input directly from the 
scripts whereas docbook can be much more in-depth and can focus on 
specific topics such as getting started, upgrading, featured properties 
code, etc.

Comments, suggestions, rants...

Patrick