/*
 * Copyright 2016-2020 chronicle.software
 *
 * https://chronicle.software
 *
 * 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.
 */
package net.openhft.chronicle.bytes;

public interface BytesComment<B extends BytesComment<B>> {
    /**
     * Do these Bytes support saving comments
     *
     * @return true if comments are kept
     */
    default boolean retainsComments() {
        return false;
    }

    /**
     * Add comment as appropriate for the toHexString format
     *
     * @param comment to add (or ignore)
     * @return this
     */
    @SuppressWarnings("unchecked")
    default B comment(CharSequence comment)
            throws IllegalStateException {
        return (B) this;
    }

    /**
     * Adjust the indent for nested data
     *
     * @param n +1 indent in, -1 reduce indenting
     * @return this.
     */
    @SuppressWarnings("unchecked")
    default B indent(int n)
            throws IllegalStateException {
        return (B) this;
    }
}

@@ -673,16 +673,150 @@
 bytes;%0A%0A
+/**%0A * This interface is for additional description to be added to HexDumpBytes%0A */%0A// TODO rename to HexDumpBytesDescription in x.24%0A
 public i
@@ -919,16 +919,44 @@
 comments
+ as descriptions for fields.
 %0A     *%0A
@@ -995,20 +995,95 @@
 are 
-kept%0A     */
+for field descriptions%0A     */%0A    // TODO rename to retainedHexDumpDescription in x.24
 %0A   
@@ -1320,32 +1320,86 @@
 gs(%22unchecked%22)%0A
+    // TODO rename to writeHexDumpDescription in x.24%0A
     default B co
@@ -1628,32 +1628,87 @@
 n this.%0A     */%0A
+    // TODO rename to adjustHexDumpIndentation in x.24%0A
     @SuppressWar

Add TODO to rename this interface which is unrelated to writeComment()