Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rich-text: set up autogenerated API docs #14220

Merged
merged 24 commits into from
Mar 7, 2019
Merged

rich-text: set up autogenerated API docs #14220

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
22c60f5
Use a central script instead of one per package
oandregal Mar 4, 2019
e7ba662
Prepare to add more packages
oandregal Mar 4, 2019
988deb2
Merge docs:build and docs:generate
oandregal Mar 4, 2019
692faa7
Autogenerated docs and setup for rich-text
oandregal Mar 1, 2019
70d4952
Use bin script instead of npm script
oandregal Mar 4, 2019
a8fcc07
Update JSDoc from old README and regenerate
oandregal Mar 4, 2019
e984ec3
Do not document unstable APIs
oandregal Mar 4, 2019
e81f80d
Remove unstable param
oandregal Mar 4, 2019
e4ac9b0
Ignore apply and changeListType symbols
oandregal Mar 4, 2019
e9dec20
Use new script
oandregal Mar 5, 2019
7c533be
Update output
oandregal Mar 5, 2019
01ec44d
Refactor to use switch
oandregal Mar 5, 2019
bf921c5
Ignore functions that are about to be removed
oandregal Mar 6, 2019
24143b7
Update docs
oandregal Mar 6, 2019
9392d60
Ignore also indentListItem and outdentListItems
oandregal Mar 7, 2019
059d618
Fix typo
oandregal Mar 7, 2019
156d45d
Update docs
oandregal Mar 7, 2019
70647bc
Fix comment
oandregal Mar 7, 2019
50d18e5
Fix spaces
oandregal Mar 7, 2019
6e4dea7
Fix spaces
oandregal Mar 7, 2019
665c702
Ignore more symbols
oandregal Mar 7, 2019
02ba0b3
fix spaces
oandregal Mar 7, 2019
98f04d4
fix spaces
oandregal Mar 7, 2019
e4242d4
fix spaces
oandregal Mar 7, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Ignore more symbols
  • Loading branch information
@oandregal
oandregal committed Mar 7, 2019
commit 665c702042958958f7c3ca9fa04576a27371ee99
2 changes: 1 addition & 1 deletion bin/update-readmes.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ const getArgsForPackage = ( packageName ) => {
`packages/${ packageName }/src/index.js`,
`--output packages/${ packageName }/README.md`,
'--to-token',
'--ignore "unstable|experimental|^apply$|^changeListType$|^charAt$|^getSelectionStart$|^getSelectionEnd$|^indentListItems$|^insertLineBreak$|^outdentListItems$"',
'--ignore "unstable|experimental|^apply$|^changeListType$|^charAt$|^getSelectionStart$|^getSelectionEnd$|^indentListItems$|^insertLineBreak$|^insertLineSeparator$|^isEmptyLine$|^LINE_SEPARATOR$|^outdentListItems$"',
];
default:
return [
Expand Down
39 changes: 0 additions & 39 deletions packages/rich-text/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,24 +128,6 @@ none are provided.

`Object`: A new value with the value inserted.

### insertLineSeparator

[src/index.js#L23-L23](src/index.js#L23-L23)

Insert a line break character into a Rich Text value at the given
`startIndex`. Any content between `startIndex` and `endIndex` will be
removed. Indices are retrieved from the selection if none are provided.

**Parameters**

- **value** `Object`: Value to modify.
- **startIndex** `[number]`: Start index.
- **endIndex** `[number]`: End index.

**Returns**

`Object`: A new value with the value inserted.

### insertObject

[src/index.js#L24-L24](src/index.js#L24-L24)
Expand Down Expand Up @@ -197,21 +179,6 @@ objects (such as images).

`boolean`: True if the value is empty, false if not.

### isEmptyLine

[src/index.js#L15-L15](src/index.js#L15-L15)

Check if the current collapsed selection is on an empty line in case of a
multiline value.

**Parameters**

- **value** `Object`: Value te check.

**Returns**

`boolean`: True if the line is empty, false if not.

### join

[src/index.js#L16-L16](src/index.js#L16-L16)
Expand All @@ -229,12 +196,6 @@ string. This is similar to `Array.prototype.join`.

`Object`: A new combined value.

### LINE_SEPARATOR

[src/index.js#L30-L30](src/index.js#L30-L30)

Line separator character.

### registerFormatType

[src/index.js#L17-L17](src/index.js#L17-L17)
Expand Down