NativeDoc API

Click here to open the NativeDoc 3 API.

NativeDoc changelog

Because already existing code must be re-used.

The changelog is also available in the About screen of NativeDoc.

  • 3.0.3.0002 (14/01/2012)
    • Fix: Exceptions thrown during the exportation process are now handled correctly by NativeDoc GUI.
    • Fix: When "Display undocumented handler" is active, private command/function are now extracted correctly.

  • 3.0.2.0000 (29/11/2012)
    • Fix: Seealso tags now works correctly when referencing objects.
    • About screen and documentation is now rendering correctly on LiveCode 5.5

  • 3.0.1.0000 (08/10/2012)
    • The word "http" or "ftp" are not considered anymore as a link. "http://" and "ftp://" are required instead.
    • Links in about screen are working now on MacOS X.
    • Selected template is now correctly saved.

  • 3.0.0.0000 (20/09/2012)
    • Updated license limitation
      • The starter edition is now limited to 8 handler per objects. (instead of 3)

  • Core:
    • Several performances improvements!
      • A lot of critical methods has been rewrote in order to be as fast as possible!

  • /!\ API update: The command dpnd_export_HTML has changed! Check the documentation.

  • Parser:
      • New tag. "\private" The documentation will not be displayed if private handler are marked to not be generated.
      • Parameters of the kind "@pParam[out|in|in,out]" does not generate anymore a warning.
      • Added support to the HTML tag "<code>". Use it instead of "<pre>". (Better rendering)
      • Fix: Better detection of documentation blocks.
      • Support of the <code> html tag.
      • The parser detect now blocks <pre>, <div> and <code>, and strips all empty spaces at the beginning of the block and at the ends. (Create a better HTML rendering)

  • Navigator:
    • Auto-scan script, NativeDoc now automatically scan the edited objects.
      • When you go back to the Navigator, all new stack and edited objects inside the script will be scanned by the NativeDoc.
      • NativeDoc does not rescan scripts that were not modified.
      • The button "Rescan" has been renamed "Scan", and is used only to rescan all objects and the external documentation.

    • Documentation parsing errors are now directly displayed inside the Navigator.

    • Improved user interface.
      • Ability to export documentation directly from the Navigator.
      • Improved icons, and actions. More user friendly.
      • Keyboard navigation on the tree.

    • Improved external documentation handling
      • Now external docs are under the node "External documentations"
      • Clicking the external doc displays now information. (Author, path, properties etc...)
      • You can directly open the folder holding the external within the browser by clicking the path. (it is a link)

    • New search bar, now searches are through the entire navigator.
      • The search result is displayed only while doing a search.
      • New "cancel search" button, allow to close the search result in one click.
      • The results are displayed only while searching, the list is not acting anymore as a filter. (Useless because of the tree)

    • Dictionnary Navigator is now fueled by Data Tree (>= 2.0)
      • Faster than ever!
    • NativeDoc now requires the Data Tree library to be installed in order to use the Navigator.
      • If the Data Tree library is not loaded when opening the Navigator, NativeDoc will ask you if you want to download it.

  • Documentation generation:
    • New documentation generation process, easier, faster and more developper centric.
      • Save/load multiple settings.
      • Objects browser to select which ones to generates documentation for.
      • Ability to set custom properties.
      • New external documentation manager
      • Improved template manager
      • Create and define custom pages

  • Documentation:
    • New NativeDoc 3.0 user manual
      • All new features detailed
      • How-to customize template!

  • Templates:
    • Template now use "Segoe UI" and "Lucida Grande" as default font. Documentation is more readable.

  • Update:
    • It is possible to check NativeDoc updates in the about screen.

  • 2.0.0.0200 (23/10/2011)
    • NativeDoc Dictionary Navigator !
      • Browse directly inside LiveCode your source-code documentation.
      • Preview quickly what your documentation will look like.
      • Import documentation files made by other developpers.
      • The must-have feature for any developper!
      • Using the NativeSoft DataTree to navigate quickly inside the documentation.
    • Generation of xml files does not open any more the error dialog if no error.
    • dpnd_extract generates now valid package id. This fix the bug with the xml generation that generated invalid xml files.
    • Optimizations
      • The management of seealso tags is now 90x faster!
      • dpnd_ArrayMap has been rewriten, 8x time faster!

  • 1.6.0.0000 (30/10/2010)
    • Dam-pro is not anymore, hurrah for NativeSoft!
    • Fixed \seealso of a setprop/getprop
    • Seealso handlers that does not exists are not displayed anymore in the documentation
    • Added a link to open directly the NativeDoc API inside the help center
    • Few improvement in the licence manager, should make less support call ;)
    • Fixed the bug that made NativeDoc not able to use stacks located in a folder name that contained an "of" or an "id".
    • New about screen :)
    • NativeDoc now can be uninstalled from the "About" screen. (Button "Uninstall")
    • Templates are now based on JSTree 0.9.9a and jQuery 1.4.3. Make documentation a bit smaller and faster.
    • The default template is now the template without iFrame. This template is working better with any browser.
    • Templates are now looking far better on Linux.
    • Internet Explorer 6 does not anymore use the Javascript tree, instead a list is displayed.
      • If you must need the javascript tree with IE 6, use NativeDoc 1.5.1.

  • 1.5.1.1000 (17/10/2009)
    • Fixed a bug that prevented getProp and setProp properties to be handled correctly.

  • 1.5.0.5000 (22/09/2009)
    • Updated templates.
  • The template without frame does not flicker anymore, the navigation tree is hidden until he is drawn.
  • Fixed the footer resizing bug.

  • 1.5.0.0010 (15/09/2009)
    • First major update. Include new tag, and various bug fix to the parser.
    • New tag: \package alias \group

  • To use the \package tag in HTML documentation, you must use the templates of NativeDoc 1.5.
  • If you have customized your template, to add the support of the \package tag, add the following to your ndoc.css and ndoc_print.css
  • .package{
  • background: url('Icons/package.png') left no-repeat;
  • padding-left: 20px;
  • line-height: 18px;
  • }
  • And copy from the NativeDoc 1.5 templates the icon Style/Icons/package.png

    • <API new commands>
    • command dpnd_ArrayExclude @p_Array, p_ExcludePrivate, p_ExcludeEvents, p_ExcludeGetProp
      • Excludes a kind of handlers from the NativeDoc array p_Array.

    • <Bug fixes>
    • <i> is now parsed.
    • \ and _ are not displayed anymore in multi-lines commands.

    • <Regression/Improvement>
    • As regression, if the doxygen style is used, the handler declaration MUST be placed on the first line if
  • there is no \ or @.
  • Example:
  • /** on myEvent
  • * \brief On the event MyEvent...
  • */
  • Will works, but:
  • /**
  • * on myEvent
  • * \brief On the event MyEvent...
  • */
  • Will not works.
  • To makes it working, you have to place on myEvent on the first line, or you
  • have to place a "\" before the on.
  • Example:
  • /**
  • * \on myEvent
  • * \brief On the event MyEvent...
  • */
  • Will works.

    • The improvement of this regression, is that the parser will works if you place
  • a "on" or a "function" or a "private" ... at the beginning of a line.
  • Example:
  • /**
  • * On the event myEvent...
  • */
  • on myEvent
  • Did not worked in NativeDoc 1.0, because it considered the "On" as the handler description, but now it works in 1.5.


  • 1.0.1.0001 (04/08/2009)
    • First update. Fix a licence manager bug. (The existence of the licence path was not working).