search

provokateurin / dart-nextcloud

A Nextcloud client for dart
Other
20 stars 15 forks source link

Documentation #45

Open ElectrifyPowr opened 3 years ago

ElectrifyPowr commented 3 years ago

It might be nice to have some basic documentation for this plugin.

The README.md lists the features of this plugin, but doesn't contain a list of supported functions, for example.

The example.dart contains examples of different functions, but examples for Talk are missing, which makes it harder to use this plugin. This inevitably forces you to look closer into the source code of this plugin. Even though this plugin is already pretty nice, I might add.

timosturm commented 2 years ago

I want to add that the functions getPreviewByPath and getThumbnail definitely need documentation as they do not work with the path from WebDavFile. Instead they need a path without file/<username> at the beginning.