<commit_before>﻿// Copyright 2015 Coinprism, Inc.
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
//     http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System.Threading.Tasks;

namespace Openchain.Ledger
{
    /// <summary>
    /// Provides functionality for creating a database anchor.
    /// </summary>
    public interface IAnchorBuilder
    {
        Task Initialize();

        /// <summary>
        /// Creates a database anchor for the current state of the database.
        /// </summary>
        /// <returns>The task object representing the asynchronous operation.</returns>
        Task<LedgerAnchor> CreateAnchor(IStorageEngine storageEngine);

        /// <summary>
        /// Marks the anchor as successfully recorded in the anchoring medium.
        /// </summary>
        /// <param name="anchor">The anchor to commit.</param>
        /// <returns>The task object representing the asynchronous operation.</returns>
        Task CommitAnchor(LedgerAnchor anchor);
    }
}
<commit_msg>Improve code documentation in the IAnchorBuilder interface<commit_after>﻿// Copyright 2015 Coinprism, Inc.
// 
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
//     http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using System.Threading.Tasks;

namespace Openchain.Ledger
{
    /// <summary>
    /// Provides functionality for creating a database anchor.
    /// </summary>
    public interface IAnchorBuilder
    {
        /// <summary>
        /// Initializes the instance.
        /// </summary>
        /// <returns>The task object representing the asynchronous operation.</returns>
        Task Initialize();

        /// <summary>
        /// Creates a database anchor for the current state of the database.
        /// </summary>
        /// <param name="storageEngine">The source of transactions to use.</param>
        /// <returns>The task object representing the asynchronous operation.</returns>
        Task<LedgerAnchor> CreateAnchor(IStorageEngine storageEngine);

        /// <summary>
        /// Marks the anchor as successfully recorded in the anchoring medium.
        /// </summary>
        /// <param name="anchor">The anchor to commit.</param>
        /// <returns>The task object representing the asynchronous operation.</returns>
        Task CommitAnchor(LedgerAnchor anchor);
    }
}

{'fraction_non_alphanumeric': 0.10392824002474482, 'fraction_numerical': 0.0049489638107021346, 'mean_word_length': 2.625560538116592, 'pattern_counts': {'":': 0, '<': 35, '<?xml version=': 0, '>': 35, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '7234389', 'n_tokens_mistral': 792, 'n_tokens_neox': 764, 'n_words': 327}