atom / atomdoc Goto Github PK

Moved from atom/atom#15101

The Atom Workspace documentation lists a workspace item's required methods but does not list the optional methods listed in the comments of /src/workspace.js.

Once the parser hits the Returns keyword after getTitle() it thinks the description is over.

From readme I only saw that this package turn a string into an object. Even though I still don't know what exact procedure to make that happen. Can it be more beginner-friendly and add more elaborate examples that I can follow? Thx.

Mostly a question, but why does atomdoc not have support for classes (coffeescript, or es6), variables, or class properties?

With atom/atom#5165 and atom/atom#5277 merged, we should have a method of documenting services provided akin to events.

I'm thinking something along the lines of:

## Service `status-bar` v0.57.0

### `consumeStatusBar`

Essential: Provides a reference to the status bar to the consuming package.

* `statusBar` Status bar {Object}
    * `addLeftTile` A {Function} for adding a tile to the left side of the status bar
    * `addRightTile` A {Function} for adding a tile to the right side of the status bar
    * `getLeftTiles` A {Function} for getting the list of tiles on the left.
    * `getRightTiles` A {Function} for getting the list of tiles on the right.

Suppose my method returns an array of {Widgit}s. How would I state this considering that the link parsing regex is: /\{([\w.]+)\}/

• Returns {Array} of {Widget} sets the type as 'Array'
• Returns {Array{Widget}} and other combinations of nested either indicate type to be {Widget} or fail.

There seems to be a lack of support for the function name. Just wondering why. The AtomDoc comment wouldn't need to specify it I guess, maybe it should just come from the js/coffeescript itself, when parsed.

Should AtomDoc then support or expect it?

It seems that when `undefined` is in the comment, it is rendered as ``.

Source:

Result:

On the Task documentation the ::once function is showing documentation for the .once function.

The function

The documentation