Version 2 of NaturalDocs

Updated 2007-09-19 03:47:07 by JC
  What: NaturalDocs
  Where: http://www.naturaldocs.org/
  Description: Natural Docs is an open-source, extensible, multi-language documentation generator.  
               You document your code in a natural syntax that reads like plain English.  Natural Docs
               then scans your code and builds high-quality HTML documentation from it.

See also robodoc - a tool very similar to NaturalDocs.

An example of a Tcl function documented in NaturalDocs:

  #
  # Function: say_hello
  #   Say hello to the world
  # 
  # Parameters:
  #    name - (default: "World") who should we say hello to? 
  #

  proc say_hello {{name "World"}} {
    puts "Hello, $name!"
  }

Natural docs will pickup the proc line and place it in the documentation as well. In addition to this, it works well with snit as well. NaturalDocs will pick up the method xyz {} content as wel.


Category Documentation

Category Application