github.com/alibaba/ilogtail/pkg@v0.0.0-20250526110833-c53b480d046c/doc/doc.go (about)

     1  // Copyright 2021 iLogtail 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 doc
    16  
    17  var docCenter = make(map[string]map[string]Doc)
    18  
    19  // Doc generates markdown doc with the exported field.
    20  // If some field want to add comment, please use comment tag to describe it.
    21  type Doc interface {
    22  	Description() string
    23  }
    24  
    25  // Register the doc description to the doc center.
    26  func Register(category, name string, doc Doc) {
    27  	_, ok := docCenter[category]
    28  	if !ok {
    29  		docCenter[category] = make(map[string]Doc)
    30  	}
    31  	docCenter[category][name] = doc
    32  }