atom/atomdoc

Atom's documentation parser for JavaScript / CoffeeScript

Atom

Atom and all repositories under Atom will be archived on December 15, 2022. Learn more in our official announcement

Atom is a hackable text editor for the 21st century, built on Electron, and based on everything we love about our favorite editors. We designed it to be deeply customizable, but still approachable using the default configuration.

Visit atom.io to learn more or visit the Atom forum.

Follow @AtomEditor on Twitter for important announcements.

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Documentation

If you want to read about using Atom or developing packages in Atom, the Atom Flight Manual is free and available online. You can find the source to the manual in atom/flight-manual.atom.io.

The API reference for developing packages is also documented on Atom.io.

Installing

Prerequisites

• Git

macOS

Download the latest Atom release.

Atom will automatically update when a new release is available.

Windows

Download the latest Atom installer. AtomSetup.exe is 32-bit. For 64-bit systems, download AtomSetup-x64.exe.

Atom will automatically update when a new release is available.

You can also download atom-windows.zip (32-bit) or atom-x64-windows.zip (64-bit) from the releases page. The .zip version will not automatically update.

Using Chocolatey? Run cinst Atom to install the latest version of Atom.

Linux

Atom is only available for 64-bit Linux systems.

Configure your distribution's package manager to install and update Atom by following the Linux installation instructions in the Flight Manual. You will also find instructions on how to install Atom's official Linux packages without using a package repository, though you will not get automatic updates after installing Atom this way.

Archive extraction

An archive is available for people who don't want to install atom as root.

This version enables you to install multiple Atom versions in parallel. It has been built on Ubuntu 64-bit, but should be compatible with other Linux distributions.

1. Install dependencies (on Ubuntu):

sudo apt install git libasound2 libcurl4 libgbm1 libgcrypt20 libgtk-3-0 libnotify4 libnss3 libglib2.0-bin xdg-utils libx11-xcb1 libxcb-dri3-0 libxss1 libxtst6 libxkbfile1

2. Download atom-amd64.tar.gz from the Atom releases page.
3. Run tar xf atom-amd64.tar.gz in the directory where you want to extract the Atom folder.
4. Launch Atom using the installed atom command from the newly extracted directory.

The Linux version does not currently automatically update so you will need to repeat these steps to upgrade to future releases.

Building

• Linux
• macOS
• Windows

Discussion

• Discuss Atom on GitHub Discussions

License

MIT

When using the Atom or other GitHub logos, be sure to follow the GitHub logo guidelines.

atomdoc's Issues

How exactly do I use this with my project?

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.

using wrong function description

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

The function

The documentation

Issue parsing 'Returns' in description

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.

How do you handle arrays?

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.

Function name

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?

Documenting things other than functions

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

Add support for services

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.

`undefined` is rendered as ``

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

Source:

Result: