Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

Commit

Permalink
Docs improvements.
Browse files Browse the repository at this point in the history
  • Loading branch information
ma2ciek committed Feb 2, 2018
1 parent dcd22f1 commit f5b2484
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 17 deletions.
23 changes: 11 additions & 12 deletions src/model/markercollection.js
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@ import mix from '@ckeditor/ckeditor5-utils/src/mix';
* There're two types of markers. Both type of them should be added / updated by {@link module:engine/model/writer~Writer#setMarker}
* and removed by {@link module:engine/model/writer~Writer#removeMarker} methods. Both of them are stored in the {@link ~MarkerCollection}.
*
* 1. Markers added to the document. They're synchronized in the collaboration and handled in the undo.
* This type of markers is useful for solutions like spell checking or comments. Sample usage:
* writer.setMarker( markerOrName, ranges, { usingOperation: true } );
*
* 2. Markers not added to document (default ones). They can be used as bookmarks or visual markers.
* 1. Markers not added to document (default ones). They can be used as bookmarks or visual markers.
* They're great for showing results of the find, or select link when the focus is in the input,
* see https://github.com/ckeditor/ckeditor5-link/issues/13. Sample usage:
* writer.setMarker( markerOrName, ranges );
*
* 1. Markers added to the document. They're synchronized in the collaboration and handled in the undo.
* This type of markers is useful for solutions like spell checking or comments. Sample usage:
* writer.setMarker( markerOrName, ranges, { usingOperation: true } );
*
* Note: For efficiency reasons, it's best to create and keep at least markers as possible.
*/
export default class MarkerCollection {
Expand Down Expand Up @@ -247,16 +247,15 @@ mix( MarkerCollection, EmitterMixin );
* There're two types of markers. Both type of them should be added /updated by {@link module:engine/model/writer~Writer#setMarker}
* and removed by {@link module:engine/model/writer~Writer#removeMarker} methods. Both of them are stored in the {@link ~MarkerCollection}.
*
* 1. Markers not added to document (default ones). They can be used as bookmarks or visual markers.
* They're great for showing results of the find, or select link when the focus is in the input,
* see https://github.com/ckeditor/ckeditor5-link/issues/13. Sample usage:
* writer.setMarker( markerOrName, ranges );
*
* 1. Markers added to the document. They're synchronized in the collaboration and handled in the undo.
* This type of markers is useful for solutions like spell checking or comments.
* Usage:
* This type of markers is useful for solutions like spell checking or comments. Sample usage:
* writer.setMarker( markerOrName, ranges, { usingOperation: true } );
*
* 2. Markers not added to document. They can be used as bookmarks or visual markers. They're great for showing results of the find,
* or select link when the focus is in the input see https://github.com/ckeditor/ckeditor5-link/issues/13.
* Usage:
* writer.setMarker( markerOrName, ranges );
*
* Since markers are based on {@link module:engine/model/liverange~LiveRange live ranges}, for efficiency reasons, it's
* best to create and keep at least markers as possible.
*
Expand Down
10 changes: 5 additions & 5 deletions src/model/writer.js
Original file line number Diff line number Diff line change
Expand Up @@ -766,15 +766,15 @@ export default class Writer {
*
* There're two types of markers.
*
* 1. Markers added to the document. They're synchronized in the collaboration and handled in the undo.
* This type of markers is useful for solutions like spell checking or comments. Sample usage:
* writer.setMarker( markerOrName, ranges, { usingOperation: true } );
*
* 2. Markers not added to document (default ones). They can be used as bookmarks or visual markers.
* 1. Markers not added to document (default ones). They can be used as bookmarks or visual markers.
* They're great for showing results of the find, or select link when the focus is in the input,
* see https://github.com/ckeditor/ckeditor5-link/issues/13. Sample usage:
* writer.setMarker( markerOrName, ranges );
*
* 1. Markers added to the document. They're synchronized in the collaboration and handled in the undo.
* This type of markers is useful for solutions like spell checking or comments. Sample usage:
* writer.setMarker( markerOrName, ranges, { usingOperation: true } );
*
* If passed name is a name of already existing marker (or {@link module:engine/model/markercollection~Marker Marker} instance
* is passed), `range` parameter may be omitted (only for setting markers using operation). In this case marker will not be updated in
* {@link module:engine/model/model~Model#markers document marker collection}. However the marker will be added to
Expand Down

0 comments on commit f5b2484

Please sign in to comment.