go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/luciexe/legacy/annotee/annotation/doc.go (about)

     1  // Copyright 2015 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package annotation implements a state machine that constructs Milo annotation
    16  // protobufs from a series of annotation commands.
    17  //
    18  // The annotation state is represented by a State object. Annotation strings are
    19  // appended to the State via Append(), causing the State to incorporate that
    20  // annotation and advance. During state advancement, any number of the State's
    21  // Callbacks may be invoked in response to changes that are made.
    22  //
    23  // State is pure (not bound to any I/O). Users of a State should interact with
    24  // it by implementing Callbacks.
    25  package annotation