Update docs

.gitlab-ci.yml

@@ -2,12 +2,14 @@ image: cirrusci/flutter
 
 stages:
   - coverage
+  - docs
 
 variables:
   LC_ALL: "en_US.UTF-8"
   LANG: "en_US.UTF-8"
 
 coverage:
+  image: cirrusci/flutter
   stage: coverage
   coverage: '/^\s+lines.+: (\d+.\d*%)/'
   dependencies: []
@@ -16,3 +18,16 @@ coverage:
     - ./scripts/test.sh
     - ./scripts/coverage.sh
     - flutter pub pub publish --dry-run
+
+docs:
+  stage: docs
+  scripts:
+  - image: cirrusci/flutter
+    script:
+    - dartdoc
+  - image: ruby:2.3
+    script:
+    - cd docs/api/ && bundle exec jekyll build -d test
+    - cd docs/api/ && bundle exec jekyll build -d public
+  only:
+  - master

README.md

@@ -7,7 +7,7 @@ Matrix SDK for the famedly talk app written in dart.
 1. Import the sdk
 
 ```yaml
-  fluffyfluttermatrix:
+  famedlysdk:
     git:
       url: https://gitlab.com/famedly/famedlysdk.git
       ref: 77be6102f6cbb2e01adc28f9caa3aa583f914235
@@ -49,7 +49,7 @@ final loginResp = await matrix.jsonRequest(
     "type": "m.login.password",
     "user": _usernameController.text,
     "password": _passwordController.text,
-    "initial_device_display_name": "Fluffy Matrix Client"
+    "initial_device_display_name": "famedly talk"
   }
 );
 
@@ -57,7 +57,7 @@ matrix.connect(
   newToken: loginResp["token"],
   newUserID: loginResp["user_id"],
   newHomeserver: matrix.homeserver,
-  newDeviceName: "Fluffy Matrix Client",
+  newDeviceName: "famedly talk",
   newDeviceID: loginResp["device_id"],
   newMatrixVersions: ["r0.4.0"],
   newLazyLoadMembers: false

lib/src/Client.dart

@@ -27,7 +27,7 @@ import 'responses/ErrorResponse.dart';
 import 'Connection.dart';
 import 'Store.dart';
 
-/// Represents a Matrix connection to communicate with a
+/// Represents a Matrix client to communicate with a
 /// [Matrix](https://matrix.org) homeserver and is the entry point for this
 /// SDK.
 class Client {

lib/src/Event.dart

@@ -26,6 +26,7 @@ import 'package:famedlysdk/src/utils/ChatTime.dart';
 import 'package:famedlysdk/src/Client.dart';
 import './User.dart';
 
+/// A single Matrix event, e.g. a message in a chat.
 class Event {
   final String id;
   final String roomID;

lib/src/Room.dart

@@ -28,7 +28,7 @@ import 'package:famedlysdk/src/responses/ErrorResponse.dart';
 import 'package:famedlysdk/src/Event.dart';
 import './User.dart';
 
-/// FIXME use actual Matrix Stuff. This is a placeholder
+/// Represents a Matrix room.
 class Room {
   final String roomID;
   String name;

lib/src/Store.dart

@@ -33,8 +33,8 @@ import 'User.dart';
 import 'Room.dart';
 import 'Connection.dart';
 
-/// Represents a Matrix connection to communicate with a
+/// Responsible to store all data persistent and to query objects from the
-/// [Matrix](https://matrix.org) homeserver.
+/// database.
 class Store {
 
   final Client client;

lib/src/utils/ChatTime.dart

@@ -25,6 +25,7 @@
 
 import 'package:intl/intl.dart';
 
+/// Used to localize and present time in a chat application manner.
 class ChatTime {
   DateTime dateTime = DateTime.now();
 

lib/src/utils/MxContent.dart

@@ -24,6 +24,7 @@
 import 'package:famedlysdk/src/Client.dart';
 import 'dart:core';
 
+/// A file in Matrix presented by a mxc:// uri scheme.
 class MxContent {
 
   final String _mxc;