add better godocs (#3250)

This commit is contained in:
Raul Jordan 2019-08-20 17:01:55 -05:00 committed by Preston Van Loon
parent 900b550864
commit 121a277726

View File

@ -56,37 +56,37 @@ func (q *QueryFilter) Filters() map[FilterType]interface{} {
return q.queries return q.queries
} }
// SetParentRoot -- // SetParentRoot allows for filtering by the parent root data attribute of an object.
func (q *QueryFilter) SetParentRoot(val []byte) *QueryFilter { func (q *QueryFilter) SetParentRoot(val []byte) *QueryFilter {
q.queries[ParentRoot] = val q.queries[ParentRoot] = val
return q return q
} }
// SetStartSlot -- // SetStartSlot enables filtering by all the items that begin at a slot (inclusive).
func (q *QueryFilter) SetStartSlot(val uint64) *QueryFilter { func (q *QueryFilter) SetStartSlot(val uint64) *QueryFilter {
q.queries[StartSlot] = val q.queries[StartSlot] = val
return q return q
} }
// SetEndSlot -- // SetEndSlot enables filtering by all the items that end at a slot (inclusive).
func (q *QueryFilter) SetEndSlot(val uint64) *QueryFilter { func (q *QueryFilter) SetEndSlot(val uint64) *QueryFilter {
q.queries[EndSlot] = val q.queries[EndSlot] = val
return q return q
} }
// SetStartEpoch -- // SetStartEpoch enables filtering by the StartEpoch attribute of an object (inclusive).
func (q *QueryFilter) SetStartEpoch(val uint64) *QueryFilter { func (q *QueryFilter) SetStartEpoch(val uint64) *QueryFilter {
q.queries[StartEpoch] = val q.queries[StartEpoch] = val
return q return q
} }
// SetEndEpoch -- // SetEndEpoch enables filtering by the EndEpoch attribute of an object (inclusive).
func (q *QueryFilter) SetEndEpoch(val uint64) *QueryFilter { func (q *QueryFilter) SetEndEpoch(val uint64) *QueryFilter {
q.queries[EndEpoch] = val q.queries[EndEpoch] = val
return q return q
} }
// SetShard -- // SetShard enabled filtering by the Shard attribute of an object.
func (q *QueryFilter) SetShard(val uint64) *QueryFilter { func (q *QueryFilter) SetShard(val uint64) *QueryFilter {
q.queries[Shard] = val q.queries[Shard] = val
return q return q