This is the static introductory home page for FarqenDoc. FarqenDoc is a SourceForge project.
FarqenDoc happened one weekend when I got really farqen annoyed that although I could add XML comments all through my Visual Studio project, Microsoft had provided no tools to build documentation from the XML file created with my build. This and some really bad experiences with NDoc led me to believe the whole situation was growing too complex too fast.
What I was able to do in 48 hours and 960 lines of code was apparently too much to provide as a standard tool. OK, so you don't get searchable documents with fantastic linking, but you DO get a document that tells you all about your code and lets you surf around your classes, an invaluable tool to someone else wanting to, say, join your SourceForge project.
Usage of FarqenDoc is very simple. Place FarqenDoc.exe into your project's build directory (or alternatively tell Visual Studio to deposit your XML files in your FarqenDoc directory). Then, add a post-build step to your project that launches FarqenDoc from that directory - a line like this will get you started.
"$(SolutionDir)\FD.BAT" "$(SolutionDir)"
Clearly this just points to a batch file which you will create. The script then looks something like this:
cd %1% rem cd .. // My solution's various projects send the XML to a documentation rem cd xmldoc // directory containing index files to link them all. del log.txt FarqenDoc.exe >> log.txt
and produces documents that look like these.
First of all, XML comments are placed directly above your class, method or variable declarations. MSDN has documentation on the standard tags, most of which FarqenDoc supports. Visual Studio's intellitype is the easiest way to see what commands are available.
An XML comment looks like:
/// <summary>Not having FarqenDoc licks balls.</summary>
public class FarqenDoc { }
FarqenDoc supports summary, remarks, param, returns and seealso (not see) tags. For improved documentation I've added codesummary, coderemarks and codelinks, which appear on your index page.
FarqenDoc accepts arguments naming the files you want to build into documentation. If none are supplied, FarqenDoc reads all XML files in the current directory (sorry no recursion yet.)
To report bugs, request help, submit a patch or otherwise make my life a pain, please visit the project's SourceForge Page. Please note that I do not intend to spend my life maintaining and improving this software. This is a side project which I have donated to SourceForge, and I will be only too happy to make someone else the project admin.