NaturalDocs Extension

Posted by tbjers on 2007-10-25 14:44

Current Version
0.1.9

Description

Natural Docs aims to provide easy comment headers for your source code. The extension is currently undergoing heavy development, and it only works for PHP.

About Natural Docs

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.

Other Information

I would greatly appreciate any testing you guys can put it through.

Extra information

I have attached a package with a custom toolbar and a click link for inserting doc comments under the cursor. It currently maps CTRL+P to this macro, please feel free to modify it. I will integrate a toolbar into the extension release eventually, but this suffices for testing.

AttachmentSize
NaturalDocs.kpz - Toolbar package2.39 KB
naturaldocs-0.1.8-ko.xpi7.3 KB
naturaldocs-0.1.9-ko.xpi7.37 KB

Tom | Thu, 2007-10-25 16:27

For those of us who haven't heard of NaturalDocs, what are they, how do the work and how to they differ from phpDocs?

tbjers | Thu, 2007-10-25 16:34

Good question, Tom!

From the Natural Docs site:

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.

Please take a look at http://www.naturaldocs.org/documenting.html for a tutorial on how to document your source code with Natural Docs.

The next release of Natural Docs will actually have JavaDoc-style comment support, so you can parse your phpdoc comment blocks with Natural Docs.

I just recently discovered Natural Docs, and it is by far the most powerful and human-readable source code documentation format out there.

toddw
ActiveState Staff
Thu, 2007-10-25 16:40

What are the features this extension provides through Komodo? I'm confused as to what it does...

tbjers | Thu, 2007-10-25 16:50

It adds a menu item under the Code menu, NaturalDocs.

Position your cursor on the same line as a class/method/property declaration of a PHP file and run the command in the menu.

On second thought, I just tried this on a Linux box, and it doesn't seem to add the menu, or the preference section, I will have to examine the Linux jars and see what the difference is and fix it. I will re-upload the file in a while. Sorry about this. I am still very new in the XUL and Komodo world.

tbjers | Wed, 2007-10-31 19:31

I have finally managed to build the package correctly. Instead of using the komodo extension project template I am now building it with koext, which seems to package the files correctly. Please let me know if you can get this up and running on your system!