Titanium Community Questions & Answer Archive

We felt that 6+ years of knowledge should not die so this is the Titanium Community Questions & Answer Archive

Be honest ... when are the docs going to be complete?

There are still a load of APIs not documented (filesystem, supported xml dom interfaces, contacts, geolocation to name a few).

Please could you be honest and let the community know when you are going to get these complete? I feel you're starting to let yourself and current developers down.

I'm sure I'm not alone in wasting a lot of my time looking things up only to find it doesn't exist in the new docs, checking the Kitchen Sink app and then going back to the old docs which are inaccurate and do not reliably document what actually exists in the latest API (and will be redirected soon).



— asked March 16th 2010 by Mark Poston
  • documentation

6 Answers

  • As I look at the recent commits to github, I can see they're adding documentation all the time. (Moreso recently with this new site)

    We all agree the docs are all over the place, but I'm sure that no one wants it to be up to date more than the Appcelerator team themselves :)

    One thing I have found though, while having to go through the (sometimes frustrating) journey through KitchenSink, or the existing docs or even looking at the objectiveC source code to a function, is that I find I've learned a lot more in the process or have a deeper understanding - so I kind of make myself feel better about it by considering that the time isn't totally wasted. ;)

    — answered March 16th 2010 by Kosso
  • (See the updated part of this answer below)

    I don't know how it's ordered, but I found some documentation in Github, about those "options" object:

    openSaveAsDialog (there isn't a list of options for "openFileChooserDialog")

    Maybe there's documentation of everything in that not-so-html format, from this root and under those directories (for Desktop):

    APIDoc for Desktop

    And here for Mobile:

    APIDoc for Mobile

    updated: 28/10/10

    I've found that the apidoc is incorrect, is a bit fresher than the official documentation, but is outdated, the "options" object in the apidoc isn't completely correct, I found what really is the "options" object in the

    sourcecode for openFileChooserDialog

    The apidoc says there's a "defaultFile" property in the "options" object and in the sourcecode the property that is looked for is "defaultName" (And that's what worked when I tested it)

    — answered October 28th 2010 by Sebastian Ramirez
  • I just use the API Docs from the source :)

    — answered October 28th 2010 by Colton Arabsky
  • It's still frustrating to find docs with things like:

    callback    method    a callback function to fire after the user closes the dialog
    options    object    (optional) additional options for the dialog

    Great, but I'd get a lot more done if I knew what the options are actually available. Just knowing that the method takes options doesn't do any good if I don't know what they are. And what will be passed to the callback function?

    This is from the Desktop API docs for Titanium.UI.UserWindow.openFileChooserDialog. I should also note that it would be nice to know that openFileChooserDialog is actually a method of Titanium.UI, not Titanium.UI.UserWindow, and it doesn't actually return a string as documented. You know, little things like that.

    — answered March 18th 2010 by Steve King
  • Must say I'm a little disappointed there's no reply from the developers to whom this post was obviously addressed to :(
    Last commit to github apidocs section is 12 March - 1 week ago

    — answered March 19th 2010 by Mark Poston
  • If anyone would like to fork the docs from github and contribute, we'd be glad to pull.


    — answered March 20th 2010 by Jeff Haynie
The ownership of individual contributions to this community generated content is retained by the authors of their contributions.
All trademarks remain the property of the respective owner.