Библиотека mfrc522 описание функций

RockHammer
Offline
Зарегистрирован: 21.08.2017

Здравствуйте. Где найти описание всех функций библиотеки mfrc522? 

Может есть аналог сайта msdn, где как и там выкладываются все функции с описанием, желательно на русском.

Входные значения, что эта функция делает, что возвращает, примеры использовоания и т.д.

Очень нужно. Спасибо.

 

sadman41
Offline
Зарегистрирован: 19.10.2016

https://github.com/miguelbalboa/rfid/blob/master/src/MFRC522.cpp

В начале каждой функции описание. На вражеском.

RockHammer
Offline
Зарегистрирован: 21.08.2017

sadman41 пишет:

https://github.com/miguelbalboa/rfid/blob/master/src/MFRC522.cpp

В начале каждой функции описание. На вражеском.

Эх, хотелось бы на рузком и попонятней..
Но на безрыбьи и рак рыба.

Так же буду благодарен, если кто найдёт описание функций на рузком. 

sadman41
Offline
Зарегистрирован: 19.10.2016

Вам даже в гугол-переводчик лень сходить? 

Хорошая документация требует на себя кучу времени. А альтруистов в стране всё меньше и меньше.

b707
Offline
Зарегистрирован: 26.05.2017

sadman41 пишет:

Хорошая документация требует на себя кучу времени. А альтруистов в стране всё меньше и меньше.

Хорошая не обязательно значит "обьемная", по мне так 2-3 строчки на функцию вполне достаточно. Назначение функции, описание параметров, ссылка на документацию по железке или протоколу. Ровно как в этой библиотеке.  Куда больше-то? Не стоит превращать комментарии в коде в учебник по программированию.

А что на английском - автор явно русского не знает, уж извините, не выучил для вас :)

sadman41
Offline
Зарегистрирован: 19.10.2016

b707 пишет:

Хорошая не обязательно значит "обьемная", по мне так 2-3 строчки на функцию вполне достаточно. Назначение функции, описание параметров, ссылка на документацию по железке или протоколу. 

Ну, тут просят, цитирую: примеры использовоания и т.д.

Это явно не две-три строчки черкнуть. Нужно посидеть, подумать - как лучше вызвать функцию, чтобы стало понятно для чего там эти параметры. А это чертовская куча времени. Про объем же я не писал.

RockHammer
Offline
Зарегистрирован: 21.08.2017

sadman41 пишет:

b707 пишет:

Хорошая не обязательно значит "обьемная", по мне так 2-3 строчки на функцию вполне достаточно. Назначение функции, описание параметров, ссылка на документацию по железке или протоколу. 

Ну, тут просят, цитирую: примеры использовоания и т.д.

Это явно не две-три строчки черкнуть. Нужно посидеть, подумать - как лучше вызвать функцию, чтобы стало понятно для чего там эти параметры. А это чертовская куча времени. Про объем же я не писал.

Примеры использования, это из пожеланий. В основном: как раз те пресловутые 2-3 строчки, чтобы было понятно что функция делает.

b707
Offline
Зарегистрирован: 26.05.2017

RockHammer пишет:

Примеры использования, это из пожеланий. В основном: как раз те пресловутые 2-3 строчки, чтобы было понятно что функция делает.

открыл библиотеку - 2-3 строчки про каждую функцию есть, плюс описание параметров, плюс указание места в даташите с более подробным описанием. Может не туда смотрите?

ЗЫ Без английского в программировании никуда. Да и вообще в современной жизни.

RockHammer
Offline
Зарегистрирован: 21.08.2017

b707 пишет:

RockHammer пишет:

Примеры использования, это из пожеланий. В основном: как раз те пресловутые 2-3 строчки, чтобы было понятно что функция делает.

открыл библиотеку - 2-3 строчки про каждую функцию есть, плюс описание параметров, плюс указание места в даташите с более подробным описанием. Может не туда смотрите?

ЗЫ Без английского в программировании никуда. Да и вообще в современной жизни.

Я могу в английский, дело не в этом. Личное ощущение дискомфорта от того, что могу что-то прочесть не так и ошибиться.