revUp - Updates and news for the Revolution community
Issue 140 | September 21st 2012 Contact the Editor | How to Contribute

NativeDoc 3 Launch
More professional, faster, this new major version of NativeDoc is a HUGE release with dozens of new features!

by Damien Girard

It is finally here, after several months of hard work: NativeDoc 3.0.

NativeDoc Logo

This new major version has been developed to be the best companion tool for any LiveCode developer; professional and hobbyist as well. NativeDoc is a source code documentation tool for LiveCode. It enables you to put a JavaDoc/Doxygen-like documentation block inside your source code.

A Quick Tour of NativeDoc 3.0

Automatic Scan of Edited Scripts

Auto Scan

The NativeDoc Navigator detects automatically your updated scripts. You don't have to continually click the "Rescan" button anymore. Simply edit your scripts and when you open the Navigator or go back to the Navigator Window, the edited scripts are re-scanned and documentation automatically updated in the Navigator.

Documentation Parsing Errors

Documentation parsing errors
click to zoom image

NativeDoc 3.0 Navigator displays directly documentation parsing warning and errors. Now you can directly fix your documentation within the development process.

New Search Bar

New Search Bar
click to zoom image


NativeDoc 3.0 removed the object list that NativeDoc 2.0 had, the previous "filter bar" is now a "search bar".

NativeDoc automatically indexes the entire documentation, including externals; the search allows you to find instantly the handler that you need.

New Documentation Generator

Generator
click to zoom image

NativeDoc 3.0 has dropped the old documentation generator. Now it is fuelled by a fresh new window that is straightforward and professional. On the screenshot above you can see the new way to select objects to include in the documentation.

Custom Templates

Custom Properties
click to zoom image

In HTML generation, all files in the template are scanned and the text in the column "Variable in template" text is replaced by the value defined under the column "Value", e.g. ${ANIMSPEED} will be replaced by 300 in the template. Now you can define your own custom properties inside your templates.

Custom pages

Custom Pages
click to zoom image

NativeDoc 3.0 allows you to add custom pages to the generated documentation. Now you can create a complete user manual with NativeDoc. For example you can add a tutorial on how to use your API.


...And more under the hood
NativeDoc has been improved in several other areas:

  • it is faster; the parser has been improved and has new features too (e.g. a new "\private" tag).
  • The documentation has been rewritten, showing you how to use the new documentation generator and the new features of the Navigator.
  • Improved templates
  • HTML export produces a better documentation.
  • A change in licensing limits: NativeDoc now allows you to display up to 8 handlers, freely!


Pricing and availability
NativeDoc 2.0 users can upgrade to NativeDoc 3.0 for a reduced fee, via your LiveCode account. If you don't have NativeDoc already, or you have 1.0, you can purchase 3.0 immediately, here.

A little word
Thanks to all my customers, I develop NativeSoft products during my spare time; I hope that you will like this new version of NativeDoc. Your support motivates me to continue to develop great LiveCode extensions!

About the Author

Damien Girard started programming at 7. He began writing LiveCode solutions at 12. Now he works for a company as an embedded Linux expert and C/C++/C#/LiveCode programmer. He continues to release extensions for LiveCode in his spare time.

Main Menu

What's New


transform your students with LiveCode 2 for 1 this month