From 571d682c82b73e5bad80a914750429bee3c83977 Mon Sep 17 00:00:00 2001 From: sternenseemann Date: Wed, 20 May 2020 23:10:22 +0200 Subject: Update logbook doc to 0.3-1-gfacb031. --- doc/index.html | 2 +- doc/logbook/Log/index.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/index.html b/doc/index.html index 3f8471b..f1d19fe 100644 --- a/doc/index.html +++ b/doc/index.html @@ -11,7 +11,7 @@

OCaml package documentation

logbook 0.3
logbook 0.3-1-gfacb031

diff --git a/doc/logbook/Log/index.html b/doc/logbook/Log/index.html index 5dd9351..cdce94a 100644 --- a/doc/logbook/Log/index.html +++ b/doc/logbook/Log/index.html @@ -1,2 +1,2 @@ -Log (logbook.Log)

Module `Log`

OCaml representation and parsing of the log format.

v0.3 — homepage

Log

Log Representation

type privacy_level = | Private | Semi_private | Public: Describes, how private a log item is, where private means “item only visible to oneself, semi-private “item visible to trusted persons” and public “item visible to everyone”.

type 'a item = | Item of privacy_level * 'a * 'a: A log item consisting of its privacy level, a title and a text, both in markup 'a.

type 'a log_entry = | Log_entry of Ptime.date * 'a * 'a item list: A log entry consisting of a date, a summary and items, both in markup 'a.

type 'a log = 'a log_entry list: A log file consisting of multiple log entries for multiple days using markup 'a.

val compatible_privacy : privacy_level -> privacy_level -> bool: A test to check wether a privacy level of e. g. an item is compatible with the (maximum) privacy level available.

val privacy_level_of_char : char -> privacy_level option: Get the corresponding privacy level for a char

val filter_privacy_level : privacy_level -> 'a item list -> 'a item list: Remove all items incompatible with the given privacy level from the list of items.

Log Parsing

log files are parsed using angstrom.

val log_parser : string log Angstrom.t: An angstrom parser for log files

Log processing

val apply_markup : ('a -> 'b) -> 'a log -> 'b log: Convert a log's markup. This is especially useful to apply a specific markup to a freshly parsed log file.

\ No newline at end of file +Log (logbook.Log)

Module `Log`

OCaml representation and parsing of the log format.

v0.3-1-gfacb031 — homepage

Log

Log Representation

type privacy_level = | Private | Semi_private | Public: Describes, how private a log item is, where private means “item only visible to oneself, semi-private “item visible to trusted persons” and public “item visible to everyone”.

type 'a item = | Item of privacy_level * 'a * 'a: A log item consisting of its privacy level, a title and a text, both in markup 'a.

type 'a log_entry = | Log_entry of Ptime.date * 'a * 'a item list: A log entry consisting of a date, a summary and items, both in markup 'a.

type 'a log = 'a log_entry list: A log file consisting of multiple log entries for multiple days using markup 'a.

val compatible_privacy : privacy_level -> privacy_level -> bool: A test to check wether a privacy level of e. g. an item is compatible with the (maximum) privacy level available.

val privacy_level_of_char : char -> privacy_level option: Get the corresponding privacy level for a char

val filter_privacy_level : privacy_level -> 'a item list -> 'a item list: Remove all items incompatible with the given privacy level from the list of items.

Log Parsing

log files are parsed using angstrom.

val log_parser : string log Angstrom.t: An angstrom parser for log files

Log processing

val apply_markup : ('a -> 'b) -> 'a log -> 'b log: Convert a log's markup. This is especially useful to apply a specific markup to a freshly parsed log file.

\ No newline at end of file -- cgit 1.4.1