Natural Docs
About
About Natural DocsFeaturesLanguage SupportOutput FormatsDownloadDevelopment
Make a Donation
Language Support
Full Language Support

The following languages have full language support, which means you get:

Full code documentation.  All functions, variables, and classes will appear in the output regardless of whether you wrote anything for them.  This can be turned off with the -do command line option.

Inheritance diagrams.  They will appear in the output wherever appropriate.

Javadoc compatibility.  Natural Docs can read most Javadoc comments and include them in the output.  You can also write Natural Docs documentation without topic lines by using the Javadoc comment symbols.

Auto-scoping.  The class a topic is part of is determined by the source code rather than class and section topics.

  • C# (1.1, some 2.0)
  • Perl
  • ActionScript (2 and 3)
Basic Language Support

The following languages have basic language support, which means you have:

Explicit documentation only.  Only things you write Natural Docs documentation for will appear in the output.

No inheritance diagrams.

Natural Docs comments only.  They also need to include a topic line.

Topic scoping.  The class a topic is part of is determined by the topic scoping rules.

  • C/C++
  • Java
  • PHP
  • Python
  • PL/SQL
  • Visual Basic
  • Pascal/Delphi
  • Ada
  • JavaScript
  • Ruby
  • Tcl
  • ColdFusion
  • Assembly
  • Fortran (free-format only)
  • R
  • Makefiles
  • Plain Text
  • Custom Languages
Getting Full Language Support

This is the rough order in which languages will be getting full support.  It’s determined by the number of votes each language has and any donations targeted towards it.  You vote by sending me an e-mail telling me which language you want me to give full support to.  You donate towards a language by donating to the project and filling in the “Donate towards a language?” field on the second page.

I should note that there probably won’t be a lot of work done on this in the near future as I’m concentrating my effort on building Natural Docs 2.0.  You can still vote and donate, but at this point you should donate primarily because you support the project, not to nudge one language up or down.  That’s why I took down the totals that were here before.

  • JavaScript/JScript/ASP
  • PHP
  • C/C++
  • Ada
  • Python
  • D
  • ColdFusion
  • Pascal/Delphi
  • Java
  • PL/SQL
  • Ruby
  • Visual Basic
  • Fortran
  • Lua
  • Lisp
  • Oberon
  • MathLab/Octave
Copyright © 2003-2011 Greg Valure