lib/repo: Add gtk-doc comment to OstreeRepoCommitState
authorPhilip Withnall <withnall@endlessm.com>
Wed, 8 Nov 2017 15:11:25 +0000 (15:11 +0000)
committerAtomic Bot <atomic-devel@projectatomic.io>
Wed, 8 Nov 2017 15:47:11 +0000 (15:47 +0000)
Signed-off-by: Philip Withnall <withnall@endlessm.com>
Closes: #1335
Approved by: cgwalters

src/libostree/ostree-repo.h

index 9a1b65ae1e2c13ec28950eb0ddfb5ae18ccf1aae..bec43c30ab1b2fbf1d89a66eb9989763db4108d0 100644 (file)
@@ -539,6 +539,18 @@ gboolean      ostree_repo_load_variant_if_exists (OstreeRepo  *self,
                                                   GVariant     **out_variant,
                                                   GError       **error);
 
+/**
+ * OstreeRepoCommitState:
+ * @OSTREE_REPO_COMMIT_STATE_NORMAL: Commit is complete. This is the default.
+ *    (Since: 2017.14.)
+ * @OSTREE_REPO_COMMIT_STATE_PARTIAL: One or more objects are missing from the
+ *    local copy of the commit, but metadata is present. (Since: 2015.7.)
+ *
+ * Flags representing the state of a commit in the local repository, as returned
+ * by ostree_repo_load_commit().
+ *
+ * Since: 2015.7
+ */
 typedef enum {
   OSTREE_REPO_COMMIT_STATE_NORMAL = 0,
   OSTREE_REPO_COMMIT_STATE_PARTIAL = (1 << 0),