NativeDoc is a source code documentation tool for LiveCode.
NativeDoc enables you to browse or generate a documentation from your source code.
The documentation is extracted directly from the scripts and is directly browsable within the LiveCode IDE. Review, search and navigate through your documentation with NativeDoc.
How to get started?
Download the repository, and extract it to your LiveCode extension folder.
You can locate the user plugins folder by doing so:
- Open LiveCode preferences
- In the Files & Memory preferences pane you can find the full path to the User Extensions folder.
- Open this folder in your system file browser.
- If it doesn't exists, create a "Plugins" subfolder.
- Extract NativeDoc into the "Plugins" subfolder.
- Start LiveCode and the NativeGeometry plugin window will be displayed.
Make sure that "rev_NativeDoc_Launcher.rev" file is at the root of the Plugins folder, LiveCode will automatically execute this file that will load NativeDoc.
Once NativeDoc is opened, click "Help Center".
NativeDoc doesn't have an automated test suite. For each release a set of manual tests cases need to be executed.
Before a push request can be made, you will have to perform manual tests with NativeDoc, and mark them as you didn't introduced a regression.
How to contribute?
The workflow is a typical git workflow, where contributors fork the dagirard/NativeDoc repository, make their changes on a branch, and then submit a pull request.
Note: Before commit, you must run
"NativeDoc.res\Devel\NativeDocCleaner.rev" in order to clean up development variables.
NativeDoc is under the LGPL 3.0 license. A complete copy is available in the file COPYING.TXT, COPYING.LESSER.TXT
NativeSoft, DataTree, NativeDoc, NativeGeometry, the NativeSoft logo, the DataTree logo, the NativeGeometry logo, the NativeDoc logo, NativeSpeak, are registered trademarks of Damien André Edouard Girard, registered in France and other countries.