1 /* 2 * Copyright (C) 2024 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 package com.android.internal.widget.remotecompose.core.documentation; 17 18 import android.annotation.NonNull; 19 20 public interface DocumentationBuilder { 21 22 /** 23 * Add arbitrary text to the documentation 24 * 25 * @param value 26 */ add(@onNull String value)27 void add(@NonNull String value); 28 29 /** 30 * Add the operation to the documentation 31 * 32 * @param category category of the operation 33 * @param id the OPCODE of the operation 34 * @param name the name of the operation 35 * @return a DocumentedOperation 36 */ 37 @NonNull operation(@onNull String category, int id, @NonNull String name)38 DocumentedOperation operation(@NonNull String category, int id, @NonNull String name); 39 40 /** 41 * Add the operation to the documentation as a Work in Progress (WIP) operation 42 * 43 * @param category category of the operation 44 * @param id the OPCODE of the operation 45 * @param name the name of the operation 46 * @return a DocumentedOperation 47 */ 48 @NonNull wipOperation(@onNull String category, int id, @NonNull String name)49 DocumentedOperation wipOperation(@NonNull String category, int id, @NonNull String name); 50 } 51