Skip to content

Commit 827830d

Browse files
committed
Поправил jsDoc
1 parent e61ec8a commit 827830d

2 files changed

Lines changed: 54 additions & 59 deletions

File tree

README.md

Lines changed: 21 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
+ Неотказ - notBounce()
2626

2727
## Настройки счётчика Метрики
28-
**В настройках счётчика во вкладке "Фильтры" / "Фильтрация роботов" необходимо выбрать опцию "Учитывать посещения всех роботов". В противном случае, статистика собираться не будет.**
28+
**В настройках счётчика во вкладке «Фильтры» / «Фильтрация роботов» необходимо выбрать опцию «Учитывать посещения всех роботов». В противном случае, статистика собираться не будет.**
2929

3030
## Ограничения
3131
Отчёты, которые будут недоступны в Метрике при серверной отправки:
@@ -45,7 +45,7 @@
4545
```js
4646
var http = require('http');
4747

48-
// Создаем счётчик, 12345 - номер счётчика
48+
// Создаем счётчик, 12345 номер счётчика
4949
var counter = require('yametrika').counter({id: 12345});
5050

5151
http.createServer(function (req, res) {
@@ -64,16 +64,14 @@ http.createServer(function (req, res) {
6464
## Отправка хита
6565
```js
6666
/**
67-
* @param {string} pageUrl - адрес страницы
68-
* @param {string} [pageTitle] - заголовок страницы
69-
* @param {string} [pageRef] - реферер страницы
70-
* @param {Object} [userParams] - параметры визитов
71-
* @param {string} [ut] - для запрета индексирования 'noindex'
72-
* @return {Object} this
67+
* @param {string} pageUrl - Адрес страницы.
68+
* @param {string} [pageTitle] - Заголовок страницы.
69+
* @param {string} [pageRef] - Реферер страницы.
70+
* @param {Object} [userParams] - Параметры визитов.
71+
* @param {string} [ut] - Для запрета индексирования 'noindex'
7372
*
74-
* hit: function (pageUrl, pageTitle, pageRef, userParams, ut) {}
73+
* @returns {Object} this
7574
*/
76-
7775
counter.hit('http://mysite.org', 'Main page', 'http://google.com/...');
7876

7977
// С запретом на индексирование и параметрами визитов
@@ -83,12 +81,11 @@ counter.hit('http://mysite.org', 'Main page', 'http://google.com/...', {level1:
8381
## Достижение цели
8482
```js
8583
/**
86-
* @param {string} target - название цели
87-
* @param {Object} [userParams] - параметры визитов
84+
* @param {string} target - Название цели.
85+
* @param {Object} [userParams] - Параметры визитов.
8886
*
89-
* reachGoal: function (target, userParams) {}
90-
*/
91-
87+
* @returns {Object} this
88+
*/
9289
counter.hit();
9390
counter.reachGoal('goalName');
9491

@@ -103,39 +100,32 @@ counter.reachGoal('goalName', {level1: {level2: 1}});
103100
## Внешняя ссылка
104101
```js
105102
/**
106-
* @param {string} url - адрес страницы
107-
* @param {string} [title] - заголовок страницы
108-
* @return {Object} this
103+
* @param {string} url - Адрес страницы.
104+
* @param {string} [title] - Заголовок страницы.
109105
*
110-
* extLink: function (url, title) {}
111-
* @example
106+
* @returns {Object} this
112107
*/
113-
114108
counter.extLink('http://nodejs.org');
115109
```
116110

117111
## Загрузка файла
118112
```js
119113
/**
120-
* @param {string} file - ссылка на файл
121-
* @param {string} [title] - заголовок страницы
122-
* @return {Object} this
114+
* @param {string} file - Ссылка на файл.
115+
* @param {string} [title] - Заголовок страницы.
123116
*
124-
* file: function (file, title) {}
117+
* @returns {Object} this
125118
*/
126-
127119
counter.file('http://mysite.org/secret.zip');
128120
```
129121

130122
## Параметры визитов
131123
```js
132124
/**
133-
* @param {...*} параметры визитов
134-
* @return {Object} this
125+
* @param {...*} data - Параметры визитов.
135126
*
136-
* params: function (...) {}
127+
* @returns {Object} this
137128
*/
138-
139129
counter.params({level1: {level2: {level3: 1}}});
140130

141131
// или
@@ -145,10 +135,8 @@ counter.params('level1', 'level2', 'level3', 1);
145135
## Не отказ
146136
```js
147137
/**
148-
* @return {Object} this
149-
*
138+
* @returns {Object} this
150139
*/
151-
152140
counter.notBounce();
153141
```
154142

yametrika.js

Lines changed: 33 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
* Конструктор счётчика Метрики
2020
* @constructor
2121
*
22-
* @param {Object} settings - настройки счётчика
22+
* @param {Object} settings - Настройки счётчика.
2323
*/
2424
var Counter = function(settings) {
2525
// Номер счётчика
@@ -41,14 +41,15 @@
4141

4242
Counter.prototype = {
4343
/**
44-
* Отправка хита
44+
* Отправка хита.
4545
*
46-
* @param {string} pageUrl - адрес страницы
47-
* @param {string} [pageTitle] - заголовок страницы
48-
* @param {string} [pageRef] - реферер страницы
49-
* @param {Object} [userParams] - параметры визитов
50-
* @param {string} [ut] - для запрета индексирования 'noindex'
51-
* @return {Object} this
46+
* @param {string} pageUrl - Адрес страницы.
47+
* @param {string} [pageTitle] - Заголовок страницы.
48+
* @param {string} [pageRef] - Реферер страницы.
49+
* @param {Object} [userParams] - Параметры визитов.
50+
* @param {string} [ut] - Для запрета индексирования 'noindex'.
51+
*
52+
* @returns {Object} this
5253
*
5354
* @example
5455
* counter.hit('http://mysite.org', 'Main page', 'http://google.com/...');
@@ -67,10 +68,12 @@
6768
return this;
6869
},
6970
/**
70-
* Достижение цели
71+
* Достижение цели.
72+
*
73+
* @param {string} target - Название цели.
74+
* @param {Object} [userParams] - Параметры визитов.
7175
*
72-
* @param {string} target - название цели
73-
* @param {Object} [userParams] - параметры визитов
76+
* @returns {Object} this
7477
*
7578
* @example
7679
* counter.reachGoal('goalName');
@@ -90,11 +93,12 @@
9093
return this;
9194
},
9295
/**
93-
* Внешняя ссылка
96+
* Внешняя ссылка.
97+
*
98+
* @param {string} url - Адрес страницы.
99+
* @param {string} [title] - Заголовок страницы.
94100
*
95-
* @param {string} url - адрес страницы
96-
* @param {string} [title] - заголовок страницы
97-
* @return {Object} this
101+
* @returns {Object} this
98102
*
99103
* @example
100104
* counter.extLink('http://nodejs.org');
@@ -110,11 +114,12 @@
110114
return this;
111115
},
112116
/**
113-
* Загрузка файла
117+
* Загрузка файла.
114118
*
115-
* @param {string} file - ссылка на файл
116-
* @param {string} [title] - заголовок страницы
117-
* @return {Object} this
119+
* @param {string} file - Ссылка на файл.
120+
* @param {string} [title] - Заголовок страницы.
121+
*
122+
* @returns {Object} this
118123
*
119124
* @example
120125
* counter.file('http://mysite.org/secret.zip');
@@ -130,10 +135,11 @@
130135
return this;
131136
},
132137
/**
133-
* Параметры визитов
138+
* Параметры визитов.
139+
*
140+
* @param {...*} data - Параметры визитов.
134141
*
135-
* @param {...*} параметры визитов
136-
* @return {Object} this
142+
* @returns {Object} this
137143
*
138144
* @example
139145
* counter.params({level1: {level2: {level3: 1}}});
@@ -164,9 +170,9 @@
164170
return this;
165171
},
166172
/**
167-
* Не отказ
173+
* Не отказ.
168174
*
169-
* @return {Object} this
175+
* @returns {Object} this
170176
*
171177
* @example
172178
* counter.notBounce();
@@ -177,10 +183,11 @@
177183
return this;
178184
},
179185
/**
180-
* Заполнение необходимых параметров из запроса сервера для отправки данных в Метрику
186+
* Заполнение необходимых параметров из запроса сервера для отправки данных в Метрику.
181187
*
182188
* @param {Object} req
183-
* @return {Object} this
189+
*
190+
* @returns {Object} this
184191
*
185192
* @example
186193
* counter.req(req);

0 commit comments

Comments
 (0)