[geary/wip/conversation-polish: 2/22] Add some doc comments to Geary.Email
- From: Michael Gratton <mjog src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [geary/wip/conversation-polish: 2/22] Add some doc comments to Geary.Email
- Date: Tue, 29 Jan 2019 05:38:38 +0000 (UTC)
commit 98c17dd3e2c7ff631837ebba1c5d68a862484bb9
Author: Michael Gratton <mike vee net>
Date: Wed Jan 23 16:05:04 2019 +1100
Add some doc comments to Geary.Email
src/engine/api/geary-email.vala | 25 +++++++++++++++++++++++--
1 file changed, 23 insertions(+), 2 deletions(-)
---
diff --git a/src/engine/api/geary-email.vala b/src/engine/api/geary-email.vala
index dccaf75e..5f45af4d 100644
--- a/src/engine/api/geary-email.vala
+++ b/src/engine/api/geary-email.vala
@@ -235,15 +235,36 @@ public class Geary.Email : BaseObject {
public Email(Geary.EmailIdentifier id) {
this.id = id;
}
-
+
+ /**
+ * Determines if this message is unread from its flags.
+ *
+ * If {@link email_flags} is not null, returns the value of {@link
+ * EmailFlags.is_unread}, otherwise returns {@link
+ * Trillian.UNKNOWN}.
+ */
public inline Trillian is_unread() {
return email_flags != null ? Trillian.from_boolean(email_flags.is_unread()) : Trillian.UNKNOWN;
}
+ /**
+ * Determines if this message is flagged from its flags.
+ *
+ * If {@link email_flags} is not null, returns the value of {@link
+ * EmailFlags.is_flagged}, otherwise returns {@link
+ * Trillian.UNKNOWN}.
+ */
public inline Trillian is_flagged() {
return email_flags != null ? Trillian.from_boolean(email_flags.is_flagged()) : Trillian.UNKNOWN;
}
-
+
+ /**
+ * Determines if this message is flagged from its flags.
+ *
+ * If {@link email_flags} is not null, returns the value of {@link
+ * EmailFlags.load_remote_images}, otherwise returns {@link
+ * Trillian.UNKNOWN}.
+ */
public inline Trillian load_remote_images() {
return email_flags != null ? Trillian.from_boolean(email_flags.load_remote_images()) :
Trillian.UNKNOWN;
}
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]