> You need to open a bug for this. The problem is that the Apiviewer cannot > hyperlink types it doesn't know (the link in your screen shot is probably > bogus). Which behavior would you want to see in this case (add to bug)?
I've filed Bug #7646 [2] for this. For the visualization of "unknown" types I've added some points (and also the attached image). Those are just my proposals however ;) * In general it is enough to display those the same way as the API-Viewer 2.1.x did it. The link is bogus, but that's not _really_ problematic. * The tooltip shows the full namespaced type, which should be kept! * The red (ext) indication is just a proposal (feel free to change), but any indication that this is not a "known type" should be there. This is also true -and should be the same- for parameter of unknown type. * The graphical indication (blue X) is not necessary, I just played around a bit. Thanks in advance and regards, Peter [2] http://bugzilla.qooxdoo.org/show_bug.cgi?id=7646 > > T. > > > On 08/06/2013 04:48 PM, Peter Schneider wrote: >> 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: extAPI.png>>
------------------------------------------------------------------------------ Get 100% visibility into Java/.NET code with AppDynamics Lite! It's a free troubleshooting tool designed for production. Get down to code-level detail for bottlenecks, with <2% overhead. Download for free and get started troubleshooting in minutes. 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
