Skip to content

Commit

Permalink
💡 Minor changes for doc generation
Browse files Browse the repository at this point in the history
– Fix minor typo in class name that was creating issue with doc generation.
– Add JSDoc comments with links to Slack API for a few classes.
  • Loading branch information
raycharius committed Jun 14, 2020
1 parent d3da57b commit 9979031
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 3 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Change Log

## v0.1.4 – 2020-06-14

* Fix minor typo in class name that was creating issue with doc generation.
* Add JSDoc comments with links to Slack API for a few classes.

## v0.1.3 - 2020-06-13

* Add project logo (kudos to Alexey Chernyshov).
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "slack-block-builder",
"version": "0.1.3",
"version": "0.1.4",
"description": "Lightweight, zero-dependency library for creating Slack messages and modals, with a builder interface inspired by SwiftUI.",
"author": {
"name": "Ray East",
Expand Down
4 changes: 4 additions & 0 deletions src/blocks/divider.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ class Divider extends Block {
}
}

/**
* {@link https://api.slack.com/reference/block-kit/blocks#divider|View in Slack API Documentation}
*/

module.exports = {
Divider,
DividerDto,
Expand Down
4 changes: 2 additions & 2 deletions src/elements/base/multiselect-element.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
const SelectElement = require('./select-element');
const { props } = require('../../utility/constants');

class MutliSelectElement extends SelectElement {
class MultiSelectElement extends SelectElement {

/**
* Sets a limit to how many items the user can select in any one MultiSelect
Expand All @@ -17,4 +17,4 @@ class MutliSelectElement extends SelectElement {
}
}

module.exports = MutliSelectElement;
module.exports = MultiSelectElement;
4 changes: 4 additions & 0 deletions src/elements/overflow-menu.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,3 +43,7 @@ module.exports = {
OverflowMenu,
OverflowMenuDto,
};

/**
* {@link https://api.slack.com/reference/block-kit/block-elements#overflow|View in Slack API Documentation}
*/
4 changes: 4 additions & 0 deletions src/surfaces/home-tab.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,7 @@ module.exports = {
HomeTab,
HomeTabDto,
};

/**
* {@link https://api.slack.com/reference/surfaces/views|View in Slack API Documentation}
*/

0 comments on commit 9979031

Please sign in to comment.