diff options
author | Matthias Beyer <mail@beyermatthias.de> | 2017-06-26 19:23:19 +0200 |
---|---|---|
committer | Matthias Beyer <mail@beyermatthias.de> | 2017-06-26 19:30:02 +0200 |
commit | 9583ae06cdc2f6ab9286814ec08bf3786c0c572c (patch) | |
tree | b50d982fc8556b67fe2341dc30e4476932fa1c3b /doc | |
parent | 1b88c22decf168e2e02961c85cf5190ed44b6dc5 (diff) |
Add README/documentation
Diffstat (limited to 'doc')
-rw-r--r-- | doc/src/05100-lib-annotation.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/src/05100-lib-annotation.md b/doc/src/05100-lib-annotation.md new file mode 100644 index 00000000..a40842cc --- /dev/null +++ b/doc/src/05100-lib-annotation.md @@ -0,0 +1,15 @@ +## libimagannotation + +This library provides annotation functionality for entries. + +Annotations are normal Store entries, but their header at +`annotation.is_annotation` is set to `true`. + +Annotations are linked to an entry (as in `libimagentrylink`). + +### Library functionality + +The library features two traits: One to extend an `Entry` with annotation +functionality and another one for extending the `Store` with functionality to +get annotations of an entry and all annotations in the store. + |