Hi Omri, On 11/30/2011 06:44 PM, omrihar wrote: > Hi List, > > I have recently began using the api-viewer for my app, and as a side effect > actually started documenting better my code :) However I came across two > issues of which I'm not so sure: > > 1. After a recompilation of the api (./generate.py api), and after having > documented every part that it usually requires to document (as far as I can > see), it still marks some of my classes with a ! sign. Is there a way to ask > the api generator why it isn't content with my code?
In the Apiviewer, go to the class that has the warning sign. In the class documentation, any class feature that lacks in documentation is marked with a little red square with a white "x" in it. Opening that feature should give you more info on the location in the source file where documentation is missin. - Does this answer your question? If you have added JSDoc's to all of these features and it is still complaining, maybe you made a formatting error in the JSDoc. You can run the 'pretty' job on your project which has an option to insert JSDocs. This might garble your formatting a bit, but will introduce syntactically correct JSDocs that will be recognized by the Apiviewer. > 2. Is there a way to tell the API generator NOT to generate a list of all > the setProperty, getProperty, isProperty and toggleProperty for properties > defined using the property system? I have always found it unnecessary and > unhelpful to have a huge list of methods whose presence I can infer from the > fact that the properties are defined, so that it hides all the "unique" > methods which are not defined automatically. The Apiviewer has a button bar in the upper right corner. The first says "Properties". Toggling this will show/hide the generated accessor methods for properties. (BTW, all those buttons are about toggling visibility of certain class features. Have you tried them?!). T. ------------------------------------------------------------------------------ All the data continuously generated in your IT infrastructure contains a definitive record of customers, application performance, security threats, fraudulent activity, and more. Splunk takes this data and makes sense of it. IT sense. And common sense. http://p.sf.net/sfu/splunk-novd2d _______________________________________________ qooxdoo-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
