/nme-documentor

Attempt to generate NME documentation from the open-source Flex SDK.

Primary LanguageHaxe

NME Documentation Generator

This tool can be used to fetch the open-source Apache Flex SDK documentation and apply it to the NME source code, as a starting point for a full-fledged NME documentation.

How to make it work

  • Build it with haxe -cp src -neko nmedocumentor.n -main Main
  • Run it with neko nmedocumentor.n with the following arguments:
  • -in <path to the 'nme' folder in NME source>
  • -out <path to the output folder>
  • -verbose (optional)
  • -proxy <host>:<port> (optional, no proxy by default)
  • -locale <locale> (optional, default en_US, also supported de_DE, fr_FR, ja_JP, ru_RU and zh_CN)

What it does

  • Fetches the full Flex SDK documentation from the Flex SDK SVN;
  • Parse that documentation and extract meaningful data;
  • Goes through the whole nme package in the NME source code, and apply the documentation to a copy of that directory.

What it don't

  • It doesn't remove any existing NME documentation, which can lead to some stuff being documented twice (but as of now, it seems that only a couple of classes are already documented).
  • It doesn't update the text content to speak about NME where Flash or AIR is mentioned.
  • It doesn't handle images and tables. Instead, those are removed.
  • It doesn't document what isn't documented in the Flex SDK.

Why?

This tool helps starting a whole NME documentation by using the fact that the NME API mirrors the Flash API. It would be best used only once, and then proofread and merged in NME itself, but it can also be used locally.