/*
 * Copyright 2026 The Android Open Source Project
 *
 * 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 com.android.internal.widget.remotecompose.core.documentation;

import android.annotation.NonNull;
import android.annotation.Nullable;

/**
 * Interface for a documented field
 */
public interface DocumentedField {
    /**
     * Returns the size of the field
     *
     * @return
     */
    int getSize();

    /**
     * Returns the string representation of the field size
     *
     * @return
     */
    @Nullable String getVarSize();

    /**
     * Returns the string representation of the field
     *
     * @return
     */
    @NonNull String toDoc();
}
