qDoc - Kdb+ HTML Documentation Generator

qDoc is a tool for generating API documentation in HTML format from doc comments in q source code.
The qDoc format is heavily based on the JavaDoc format. qDoc is ran from the tools menu, when called it will generate documentation for all open files.

QDoc Command Line

QDoc can be ran from the command line, this allows it to be used as part of automated build systems.

java -cp qstudio.jar com.timestored.qdoc.QDocMain <sourceFolder> <targetFolder>

How to write doc comments for qDoc

Example

/ ######################### logging to disk/table/console / a logger based on java's, including handlers,filters,formatters. But note there is only one gloal logger. / handlers - are notified when a logging event occurs / formatters - convert a logrecord into a string / filters - restrict what messages are actually logged / . / eg .logger.info["myClass";"err txt message"] \d .logger / ### log an actual message, notice its spelt with a Q, loQ, apply all handlers to this latest log entry / @param level - a logger.levels symbol, in order (higher priority first) `SEVERE`WARNING`INFO`CONFIG`FINE`FINER`FINEST / @param class - a string describing the class/namespace the logging is occuring in / @param message - the message to log loq:{ [level;class;message] // using a dictionary allows handlers arguments to be changed in future + allows overloading logRecord:(`level`class`message)!(level;class;message); // pass the logRecord to all handlers (til count handlers) handlers \:logRecord; } /### change any arg passed in, into a string frmt:{$[10=abs type x; x; @[{""{x,"\n",y}/.h.td x}; x; "\r\n",.Q.s x]]} \d .

Output