apify
apify copied to clipboard
jbalsas
API documentation generator
Private APIs must be written clearly and distinguished from Public APIs either specifically writing it and/or adding a unique formatting style. 
The help message for using apify states that the flag for exlcuding files/directories is "exclude" but its actually "excludes"
E.g. http://brackets.io/docs/current/modules/view/MainViewManager.html#-_sortWorkingSet Private members are hidden by default, so the hash part of the URL won't scroll to it. Fixing this _might_ be as simple as something like: ``` .member.private:target...
1. Type "getSelection" in the upper right field Result: nothing happens Expected: searches the docs for the text "getSelection" It looks like the search field only searches the file and...
Version 10.2 is available and has many improvements. https://github.com/twitter/typeahead.js/blob/master/CHANGELOG.md
these are pretty tough but here is a simple example of a type: ``` javascript /** * A number, or a string containing a number. * @typedef {(number|string)} NumberLike */...
http://brackets.io/docs/current/modules/command/Commands.html is basically blank. Ideally it would list all the constants that are exported. This seems to be working for other modules, though -- e.g. [Menus](http://brackets.io/docs/current/modules/command/Menus.html) does include things like...
Markdown formatting is supported in Descriptions, but not in `@param`, `@return`, etc. For example, this: ``` * @return {$.Promise} * A promise that is resolved with three parameters: * contents...
According to http://usejsdoc.org/about-getting-started.html: "JSDoc comments should generally be placed immediately before the code being documented. It must start with a `/**` sequence in order to be recognized by the JSDoc...
The apify command-line program fails when I use `.` as the input source directory, but it works fine when I use other paths to refer to the same directory, like...
