From 827830d328a242708673645bf16be98bf45b43bc Mon Sep 17 00:00:00 2001 From: Denis Seleznev Date: Wed, 1 Jun 2016 23:27:48 +0300 Subject: [PATCH] =?UTF-8?q?=D0=9F=D0=BE=D0=BF=D1=80=D0=B0=D0=B2=D0=B8?= =?UTF-8?q?=D0=BB=20jsDoc?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 54 +++++++++++++++++++---------------------------- yametrika.js | 59 +++++++++++++++++++++++++++++----------------------- 2 files changed, 54 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index ee3057c..4a15777 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ + Неотказ - notBounce() ## Настройки счётчика Метрики -**В настройках счётчика во вкладке "Фильтры" / "Фильтрация роботов" необходимо выбрать опцию "Учитывать посещения всех роботов". В противном случае, статистика собираться не будет.** +**В настройках счётчика во вкладке «Фильтры» / «Фильтрация роботов» необходимо выбрать опцию «Учитывать посещения всех роботов». В противном случае, статистика собираться не будет.** ## Ограничения Отчёты, которые будут недоступны в Метрике при серверной отправки: @@ -45,7 +45,7 @@ ```js var http = require('http'); -// Создаем счётчик, 12345 - номер счётчика +// Создаем счётчик, 12345 — номер счётчика var counter = require('yametrika').counter({id: 12345}); http.createServer(function (req, res) { @@ -64,16 +64,14 @@ http.createServer(function (req, res) { ## Отправка хита ```js /** - * @param {string} pageUrl - адрес страницы - * @param {string} [pageTitle] - заголовок страницы - * @param {string} [pageRef] - реферер страницы - * @param {Object} [userParams] - параметры визитов - * @param {string} [ut] - для запрета индексирования 'noindex' - * @return {Object} this + * @param {string} pageUrl - Адрес страницы. + * @param {string} [pageTitle] - Заголовок страницы. + * @param {string} [pageRef] - Реферер страницы. + * @param {Object} [userParams] - Параметры визитов. + * @param {string} [ut] - Для запрета индексирования 'noindex' * - * hit: function (pageUrl, pageTitle, pageRef, userParams, ut) {} + * @returns {Object} this */ - counter.hit('http://mysite.org', 'Main page', 'http://google.com/...'); // С запретом на индексирование и параметрами визитов @@ -83,12 +81,11 @@ counter.hit('http://mysite.org', 'Main page', 'http://google.com/...', {level1: ## Достижение цели ```js /** - * @param {string} target - название цели - * @param {Object} [userParams] - параметры визитов + * @param {string} target - Название цели. + * @param {Object} [userParams] - Параметры визитов. * - * reachGoal: function (target, userParams) {} -*/ - + * @returns {Object} this + */ counter.hit(); counter.reachGoal('goalName'); @@ -103,39 +100,32 @@ counter.reachGoal('goalName', {level1: {level2: 1}}); ## Внешняя ссылка ```js /** - * @param {string} url - адрес страницы - * @param {string} [title] - заголовок страницы - * @return {Object} this + * @param {string} url - Адрес страницы. + * @param {string} [title] - Заголовок страницы. * - * extLink: function (url, title) {} - * @example + * @returns {Object} this */ - counter.extLink('http://nodejs.org'); ``` ## Загрузка файла ```js /** - * @param {string} file - ссылка на файл - * @param {string} [title] - заголовок страницы - * @return {Object} this + * @param {string} file - Ссылка на файл. + * @param {string} [title] - Заголовок страницы. * - * file: function (file, title) {} + * @returns {Object} this */ - counter.file('http://mysite.org/secret.zip'); ``` ## Параметры визитов ```js /** - * @param {...*} параметры визитов - * @return {Object} this + * @param {...*} data - Параметры визитов. * - * params: function (...) {} + * @returns {Object} this */ - counter.params({level1: {level2: {level3: 1}}}); // или @@ -145,10 +135,8 @@ counter.params('level1', 'level2', 'level3', 1); ## Не отказ ```js /** - * @return {Object} this - * + * @returns {Object} this */ - counter.notBounce(); ``` diff --git a/yametrika.js b/yametrika.js index a98ecee..aa692d9 100644 --- a/yametrika.js +++ b/yametrika.js @@ -19,7 +19,7 @@ * Конструктор счётчика Метрики * @constructor * - * @param {Object} settings - настройки счётчика + * @param {Object} settings - Настройки счётчика. */ var Counter = function(settings) { // Номер счётчика @@ -41,14 +41,15 @@ Counter.prototype = { /** - * Отправка хита + * Отправка хита. * - * @param {string} pageUrl - адрес страницы - * @param {string} [pageTitle] - заголовок страницы - * @param {string} [pageRef] - реферер страницы - * @param {Object} [userParams] - параметры визитов - * @param {string} [ut] - для запрета индексирования 'noindex' - * @return {Object} this + * @param {string} pageUrl - Адрес страницы. + * @param {string} [pageTitle] - Заголовок страницы. + * @param {string} [pageRef] - Реферер страницы. + * @param {Object} [userParams] - Параметры визитов. + * @param {string} [ut] - Для запрета индексирования 'noindex'. + * + * @returns {Object} this * * @example * counter.hit('http://mysite.org', 'Main page', 'http://google.com/...'); @@ -67,10 +68,12 @@ return this; }, /** - * Достижение цели + * Достижение цели. + * + * @param {string} target - Название цели. + * @param {Object} [userParams] - Параметры визитов. * - * @param {string} target - название цели - * @param {Object} [userParams] - параметры визитов + * @returns {Object} this * * @example * counter.reachGoal('goalName'); @@ -90,11 +93,12 @@ return this; }, /** - * Внешняя ссылка + * Внешняя ссылка. + * + * @param {string} url - Адрес страницы. + * @param {string} [title] - Заголовок страницы. * - * @param {string} url - адрес страницы - * @param {string} [title] - заголовок страницы - * @return {Object} this + * @returns {Object} this * * @example * counter.extLink('http://nodejs.org'); @@ -110,11 +114,12 @@ return this; }, /** - * Загрузка файла + * Загрузка файла. * - * @param {string} file - ссылка на файл - * @param {string} [title] - заголовок страницы - * @return {Object} this + * @param {string} file - Ссылка на файл. + * @param {string} [title] - Заголовок страницы. + * + * @returns {Object} this * * @example * counter.file('http://mysite.org/secret.zip'); @@ -130,10 +135,11 @@ return this; }, /** - * Параметры визитов + * Параметры визитов. + * + * @param {...*} data - Параметры визитов. * - * @param {...*} параметры визитов - * @return {Object} this + * @returns {Object} this * * @example * counter.params({level1: {level2: {level3: 1}}}); @@ -164,9 +170,9 @@ return this; }, /** - * Не отказ + * Не отказ. * - * @return {Object} this + * @returns {Object} this * * @example * counter.notBounce(); @@ -177,10 +183,11 @@ return this; }, /** - * Заполнение необходимых параметров из запроса сервера для отправки данных в Метрику + * Заполнение необходимых параметров из запроса сервера для отправки данных в Метрику. * * @param {Object} req - * @return {Object} this + * + * @returns {Object} this * * @example * counter.req(req);