Hi,

I can not find[1] any documentation on how to correctly specify return types
for "external" / "ignored" types...

When I use an external Library (in my case googles Map API) I have to inform
the generator about the usage of those identifiers [ @ignore(...) ].

But how to tell the generator not to complain about 'unknown type' when
documenting those as return value types?


Consider this example:
--------------------------------------------------------------------------------
/**
 * This map-provider wraps the native GoogleMaps v3 JavaScript-API into the
 * application namespace (app).
 *
 * @ignore(google.maps.LatLng)
// ...
 */
qx.Class.define("app.ui.map.provider.Google3",
{
// ...

    /**
     * Return the center-coordinate in map-provider native format.
     *
     * @return {google.maps.LatLng} Center-coordinate (map-provider specific
     *   format)
     */
    getNativeCenter : function () {
      return this.__mapInstance ? this.__mapInstance.getCenter() : null;
    },
// ...
--------------------------------------------------------------------------------

The generated API-Viewer is not happy about this (see attachment)

Can someone point me into the right direction?

Regards,
  Peter



[1] I've looked at
    http://manual.qooxdoo.org/3.0/pages/development/api_jsdoc_ref.html

-- 


***********************************************
Achtung, wir sind umgezogen!
Unsere neue Adresse:
TIS GmbH
Müller-Armack-Str. 8
46397 Bocholt
***********************************************

<<attachment: DocumentationErrors.png>>

------------------------------------------------------------------------------
Get your SQL database under version control now!
Version control is standard for application code, but databases havent 
caught up. So what steps can you take to put your SQL databases under 
version control? Why should you start doing it? Read more to find out.
http://pubads.g.doubleclick.net/gampad/clk?id=48897031&iu=/4140/ostg.clktrk
_______________________________________________
qooxdoo-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel

Reply via email to