update docs

Author: janstuemmel

ldapfilter.go

@@ -7,17 +7,18 @@ type Filter interface {
 	Append(filter Filter)
 }
 
-// AND
-
+// AndFilter filters entries by and operation
 type AndFilter struct {
 	Type     string
 	Children []Filter
 }
 
+// NewAndFilter inititalizes a new AndFilter
 func NewAndFilter() *AndFilter {
 	return &AndFilter{Type: "and"}
 }
 
+// Match matches entry input
 func (f *AndFilter) Match(input Input) bool {
 	for _, filter := range f.Children {
 		if !filter.Match(input) {
@@ -27,21 +28,23 @@ func (f *AndFilter) Match(input Input) bool {
 	return true
 }
 
+// Append appends a new filter
 func (f *AndFilter) Append(filter Filter) {
 	f.Children = append(f.Children, filter)
 }
 
-// OR
-
+// OrFilter filters entries by or operation
 type OrFilter struct {
 	Type     string
 	Children []Filter
 }
 
+// NewOrFilter inititalizes a new OrFilter
 func NewOrFilter() *OrFilter {
 	return &OrFilter{Type: "or"}
 }
 
+// Match matches entry input
 func (f *OrFilter) Match(input Input) bool {
 	if len(f.Children) == 0 {
 		return true
@@ -54,22 +57,24 @@ func (f *OrFilter) Match(input Input) bool {
 	return false
 }
 
+// Append appends a new filter
 func (f *OrFilter) Append(filter Filter) {
 	f.Children = append(f.Children, filter)
 }
 
-// EQUALITY
-
+// EqualityFilter filters entries by equality
 type EqualityFilter struct {
 	Type  string
 	Key   string
 	Value string
 }
 
+// NewEqualityFilter inititalizes a new EqualityFilter
 func NewEqualityFilter() *EqualityFilter {
 	return &EqualityFilter{Type: "equality"}
 }
 
+// Match matches entry input
 func (f *EqualityFilter) Match(input Input) bool {
 	if values, ok := input[f.Key]; ok {
 		for _, value := range values {
@@ -81,4 +86,6 @@ func (f *EqualityFilter) Match(input Input) bool {
 	return false
 }
 
+// Append does not appand anything here,
+// because EqualityFilter is already a leaf
 func (f *EqualityFilter) Append(filter Filter) {}