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.

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

Locker documentation #15

Merged
merged 5 commits into from
Nov 7, 2019

Conversation

BarbaraVujicic
Copy link
Contributor

Napravila sam dokumentaciju samo za Locker.h file.
U pravilu bi ljudi trebali koristiti samo Locker klasu, a LockerHelpers je klasa vise interna, pa joj nije toliko potrebna dokumentacija.
Kad nadem vremena, napravim mozda i na njoj.
Zasad sam samo ovu nabrzaka.

I da, trebat ce i README updateati, radi novih imena metoda. :( 🔫

Copy link
Member

@jabou jabou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Private helpere netreba trenutno dikumentirati posto su sada sakriveni od usera.

Provjeri samo za property canUseAuthenticationWithBiometrics ako ima potrebe da nam on vraca neki enum value. Iz naminga bih rekao da se ocekuje neka bool vrijednost, a i ima mi smisla da se ovdje vrati samo bool.

Comment on lines +23 to +25
/**
The biometrics type that the device supports (None, TouchID, FaceID).
*/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/**
 The biometrics type that the device supports

 Available states: None, TouchID, FaceID
 */


/**
The biometrics type that the device supports which is enabled in the device settings.
*/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this could be just a BOOL value?
In conbination with deviceSupportsAuthenticationWithBiometrics you can check if user can use for example FaceID 🤔
What do you think?

@BarbaraVujicic
Copy link
Contributor Author

Nisam sigurna sto je bolje, enum ili bool.
Meni je za EBC npr bolji enum jer mi tamo gdje koristim tu metodu uglavnom treba tocan tip biometrije. Ako me i ne zanima tocan tip, vec samo da li se moze koristiti nekakva biometrija, onda samo provjerim da je razlicito od BiometricsTypeNone.
U suprotnom slucaju morala bih raditi helper metodu.

Ne znam, koliko ima smisla, ali mozda bi mogli imati i dvije metode, jedna koja vraca enum, druga bool. Nisam pametna 🤔

@jabou
Copy link
Member

jabou commented Nov 5, 2019

Ostavimo za sada onda ovako, pa ako ce biti potrebe dodamo jos jedan property i ovaj stavimo kao deprecated :)

Azuriras samo Readme s novim nazivima metoda i dodaj Swift verzije koda u doc, pa mozemo mergati onda ovaj PR

@jabou jabou merged commit 609f1cf into feature/rename-and-swift-support Nov 7, 2019
@jabou jabou deleted the feature/documentation branch November 7, 2019 08:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants